# Welcome
Welcome to SUPgpt for iPhone/iPad documentation.
If you are looking for the Mac version click [here](https://macdocs.supgpt.app)
# API Keys
The app requires at least one API key to function, and it **specifically requires an OpenAI API key for advanced tools** such as web content extraction and knowledge files.
## How to Obtain API Keys
To use the app's features, you must individually sign up for each API provider and create your API keys:
* OpenAI
* Anthropic
* Google
* Groq
## Adding API Keys to the App
#### Open Settings
Access the Settings by tapping on the  button on the **Chats** screen.
#### Input Your API Keys
In the App Settings panel select **API Keys** and paste your keys into their respective fields. The app automatically saves your entries.
## API Key Storage
Your API keys are encrypted and stored locally on your device.
## Syncing API Keys Across Devices
Please note that API keys are not synced between devices. If you use the app on multiple devices, you will need to enter your keys manually for each instance.
# Starting a New Chat
From the chat list screen, tap the  button. You can then select either a new temporary chat or a new persistent chat.
{% hint style="info" %}
To learn the difference between temporary and persistent chats, follow [this link](/chat/chat/persistent-and-temporary-chat).
{% endhint %}
# Accessing App Settings
Access the Settings by tapping on the  button on the **Chats** screen.
# API Keys
Each API key must be entered into its respective field to activate the models and features associated with these services. Changes are automatically saved.
# General
The following settings are available in the General section:
#### Appearance
This setting allows the app's theme to match the iPhone/iPad system theme. Options include **System** (to follow the OS appearance), **Light**, and **Dark** modes
#### New Temp Chat
If 60 minutes have passed since the app was sent in the background, a new temporary chat will automatically start when the app is reopened.
{% hint style="info" %}
Learn more about temporary chats go [here](/chat/chat/persistent-and-temporary-chat)
{% endhint %}
# Chat
## New Chat Defaults
Configure the default settings for all new chats.
#### Model
Set the default model to be used in a new chat.
#### Context Window Limit
Define the context window limit for new chats. Deleting the contents of this field will reset the limit to the maximum allowed for the selected model.
#### Output Limit
Specify the output limit for new chats. Deleting the contents of this field will set the output limit to unlimited.
{% hint style="info" %}
Context Window Limit and Output Limit are using tokens.
{% endhint %}
## Available Models
This section provides information about all available models, including the following details:
* **Provider**: The source of the model.
* **Max Context Window**: The maximum context window for each model.
* **Max Output Limit**: The maximum output limit for each model.
* **Tool Usage**: Indicates whether the model can utilize additional tools.
Additionally, unused models can be disabled to prevent them from appearing in the model selection.
# Tools
## New Chat Tools Defaults
Configure the default tools settings for all new chats.
#### Enabled
Toggle tools active for new chats.
#### Knowledge Limit
Set the token limit for content retrieval when using the search tool within knowledge files. This retrieved knowledge will be utilized to answer questions related to the content of those files.
## Active Tools
View a list of all available tools along with a brief description of each. Specific tools can be deactivated for use in new chats.
{% hint style="info" %}
To learn more about tools press [here](/tools/overview)
{% endhint %}
# Image Generation
## New Chat Image Generation Defaults
Configure the default image generation settings for all new chats.
#### Enabled
Toggle image generation active for new chats.
#### Model
Set the default image model to be used in a new chat.
The remaining settings are model-specific and will change depending on the selected model.
# Manage Chats
All persistent chats are listed in the Chats screen, sorted by the date of the last message.
To delete or toggle chat as favourite swipe and tap the to delete or to toggle favourite
# Chat Settings
The chat settings affect only the current chat session and override the default chat settings. To open the chat settings tap on thebutton in the right corner.
## Chat
#### Model
Select the model to be used for the current chat session.
#### Context Window Limit
This defines the maximum size of the context, in tokens, that the model will use. Since different models calculate tokens differently, this is an approximation. If the field is empty, the context limit is set to the maximum possible value for the model.
**Keep in mind**: Your new, unsent messages and unsent attached files are not included in the context window limit. Adjust the context limit accordingly if attaching large files.
**Note**: The context window limit does not account for system parameters required for the app to function. These typically do not exceed an additional 1000 tokens per request. It is advisable to always set the limit to 1000 tokens more than your actual needs.
{% hint style="info" %}
**Hint**: If your files were not included in the context, simply set the context window limit to a larger value and submit an empty message.
{% endhint %}
**Important**: Be cautious when using an empty context limit with long chats or large files, as this can quickly lead to high costs.
#### Output Limit
This defines the model's maximum response length in tokens.
#### Temperature
This setting varies by model but generally influences the predictability or creativity of the model's output. Switching between models resets this value.
#### Presence Penalty
Available on certain models only. This setting controls the repetition of specific phrases or words in the generated text. Switching between models resets this value.
#### Context Memory
Press **Change** to open the context memory panel. To learn more, refer to the [Memorize tool](/tools/memorize).
#### System Prompt
System prompts provide instructions and information to the model regarding the nature of the chat.
{% hint style="info" %}
This is the place to set a persona for the model, if needed.
{% endhint %}
## Tools
Available only for models that support tools.
#### Enabled
Toggle this setting to enable or disable the model's use of tools.
## Image
Available only for models that support tools.
#### Enabled
Toggle this setting to allow or disallow the model's ability to generate images.
#### Model
Select the model to be used for image generation.
#### Image Size
This depends on the model. Choose the desired resolution for the generated images.
#### Quality
This depends on the model:
* Standard: Default setting.
* HD: Allocates more time for image generation, resulting in higher quality images but also increased latency and price.
#### Style
This depends on the model:
* Vivid: Encourages the model to generate hyper-real and dramatic images.
* Natural: Promotes a more realistic, less hyper-real appearance in the generated images.
# Chat
# Persistent and Temporary Chat
When creating a new chat, you have the option to select whether the chat is temporary or persistent.
* **Temporary**: This chat is not saved in the database and will be lost when switching to another chat or closing the app. A temporary chat is indicated by the before the title.
* **Persistent**: This chat is saved in the database and synced across devices.
## Converting Temporary to Persistent
If you need to save a temporary chat, you can convert it to persistent by tapping the **...** in the top right corner, and then selecting **Keep.**
# Prompt Bar
To create a new line in the prompt bar, press **return**. To submit the prompt, press .
While the model is generating text or running a tool, you can interrupt the process by pressing the  button on the prompt bar.
# Attaching Files
You can attach text-based files to your message by pressing the  button located below the prompt bar and then selecting **Files**.
The contents of attached files are injected into the message. As long as the message containing the attached files is within the current context window, their content will remain accessible to the model.
**I****mportant**: For large files, you may need to adjust the context window limit.
{% hint style="info" %}
**Hint**: To have continuous access to the content of larger files, it is recommended to utilize the [Search in Files](/tools/search-in-files) tool.
{% endhint %}
# Attaching Images (Vision)
You can attach images from your Photos or take a picture directly using the Camera. To do so, tap the  button located below the prompt bar, and then select either **Photos** or **Camera**.
Attached images are injected in the message. As long as the message containing the attached images is in the current context window their content will continue to be available to the model.
**Important**: Different models, even from the same provider, handle image analysis differently in terms of cost. If you encounter a context window error with the GPT-4o Mini, it does not necessarily mean you will receive the same error with the GPT-4o, even if both are set to the same context limit. You will be notified if the context window is too small for the attached images.
# Messages
There are two types of messages: user messages (yours) and assistant messages (from the model).
You can reveal additional information and functions by tapping under each message.
Pressing scrolls to the beging of the message.
## User Message
Use messages options:
* - Copy the text of the message.
* - Delete the message from the conversation.
## Assistant Message
Assistant messages consist of up to three parts:
* Body:
* Tools:
* Fragments - Generated files and images:
When you hover over an assistant message, you will find additional options and information:
*  claude-3-5-sonnet-20240620 - The model used to generate the message.
* Input Tokens: 1 155 - The input tokens used.
* Output Tokens: 523 - The output tokens used.
* - Copy the body of the message.
* - Regenerate (if you have switched to a different model, it will use the new model to regenerate the message).
* - Delete the message from the conversation.
## Limited Markdown Support
Assistant messages support limited markdown features, including the display of code blocks and tables.
# Title Bar
The title bar contains the chat title.
The title is automatically generated after the first 4 messages. To create the title, the app uses the most cost-effective model available.
When you tap the title, you will find three options:
* Favourites - Toggle to add or remove the chat from favorites.
* Refresh - Regenerate the title, using the content of the last messages (up to 1000 tokens).
* Edit  - Set the title manually.
# Context Window Marker
The context window marker serves as a visual cue to indicate what content is within the model's context and what is outside of it. The marker automatically recalibrates its position when the context window limit setting is changed or when new messages are added to the conversation.
**Important**: The marker does not account for the message that you are about to send, which may change its position when sent.
# Overview
Models that support tool calls can extend their capabilities beyond just chatting. Tools will appear as separate messages in the chat window, displaying a preloader while the tool is being executed and an orange checkmark when the execution is complete.
The model is executing the Set active directory tool
The model has finished executing the Set active directory tool
Models that support tools
**OpenAI**:
* GPT-4o mini
* GPT-4o
* GPT-4 Turbo
* GPT-3.5 Turbo
**Anthropic**:
* Claude 3.5 Sonnet
* Claude 3 Sonnet
* Claude 3 Opus
* Claude 3 Haiku
**Google**:
* Gemini 1.5 Pro
* Gemini 1.5 Flash
* Gemini 1.0 Flash
**Groq**:
* Llama 3.1 70b
* Llama 3.1 70b
{% hint style="info" %}
OpenAI API key is required for **Search in Files** and **Extract Web Content** tools.
{% endhint %}
## Using the Tools
There is no need to explicitly specify which tool the model should use. The model will attempt to infer the appropriate tool based on the context of the conversation and the content of your prompt.
## Available Tools
### Create File
Creates a text based file.
### Read File
Reads an entire file from the generated fragments or knowledge files.
### List Files
Lists all files in the generated fragments or knowledge files.
### Search in Files
Searches throught the knowledge files for relevent information and use it as context.
### Generate Image
Generates an image using the selected image model.
### Memorize
Memorizes a piece of information making it always available in the context. You can manage the memorized snipets from the Chat Settings Panel.
### Extract Web Content
Tries to extract relative text content from a web page.
### Search Web
Performs a web search. **(Spawns assistant)**
# Create File
The Create File tool allows the model to generate text-based files. Supported file types include, but are not limited to:
* Code and script files
* CSVs
* PDFs
* Text
To view the contents of a created file, tap the  button.
To export the file, press the  button.
## Generated Fragments
All created files are available in the Generated Fragments window. To open this panel, press the button in located bellow the prompt bar.
***
# Read File
The Read File tool enables the model to access and read text-based files from two distinct sources:
* Generated files
* Knowledge files
{% hint style="info" %}
If the size of the file contents exceeds the token limit set for the context window limit, the file will not be sent to the model.
{% endhint %}
{% hint style="info" %}
It is recommended to specify the desired source when asking the model to read a file. This ensures accurate retrieval of the intended content.
{% endhint %}
# List Files
The List Files tool allows the model to retrieve a list of all generated or knowledge files associated with the current chat session.
# Search in Files
The Search in Files tool requires an **OpenAI API key**.
The Search in Files tool allows the addition of files to enhance the chat's knowledge base. Models can search for relevant information within these files and utilize it as context for responses. **Only text-based files are supported, such as texts, code, CSVs, and PDFs where the text is selectable.**
To add knowledge files, tap the button bellow the prompt bar. Tap the button to browse for files. Please wait for the files to complete processing.
***
{% hint style="info" %}
Large files may take more time to parse. While it is not mandatory, it is advisable to keep individual knowledge files under 50 MB.
{% endhint %}
{% hint style="info" %}
The models may not always choose to search in the knowledge files for content. It is a good practice to remind them to use the knowledge files to answer queries.
{% endhint %}
## Knowledge Window Limit
The Knowledge Window Limit in the **Chat Settings** defines how much content to fetch from the knowledge files.
**Important:** It is essential that the knowledge window limit is less than the context window limit of the model, otherwise, the model will not be able to use the knowledge due to its larger size.
## Time to Process
Processing approximately 3,000,000 symbols from the knowledge files takes about 1 minute when parsing. Please keep in mind that processing time will increase with larger files.
# Generate Image
To enable image generation in the app, activate the feature in either the **App Settings -> Image Generation** or in the **Chat Settings**.
***
## Model Settings
Each model has different settings to choose from.
## Saving the Image
The generated images can be saved tapping thebutton.
## Generated Fragments
All generated images are available in the Generated Fragments panel. To open this panel, tap the button bellow the prompt bar.
***
# Memorize
The Memorize tool enables the model to "remember" specific pieces of information that remain accessible in the context of the conversation.
{% hint style="info" %}
An example use of the Memorize tool would be to ask the model to always refer to the knowledge files when aswering questions.
{% endhint %}
## Modify Memory
To view and modify what the model has in its memory, tap on the **Change** button in the **Chat Settings**. Here, you can add, edit, or delete memorized pieces of information.
# Extract Web Content
The Extract Web Content tool enables the model to retrieve relevant information from a single web page and utilize it as context during the conversation.
The size (in tokens) of the retrieved content is determined by the knowledge window limit setting in the [**Chat Settings**](/chat/chat-settings)**.**
**Important:** It is essential that the knowledge window limit is less than the context window limit of the model, otherwise, the model will not be able to use the extracted web content due to its larger size.
# Search Web
The Search Web tool enables the model to perform a real-time web search to gather external information.