OpenWebUI/docs
1
0
Fork 0
mirror of https://github.com/open-webui/docs synced 2025-06-16 11:28:36 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge pull request #568 from Classic298/patch-6

Browse Source 
Update url-params.md
This commit is contained in:
Tim Jaeryang Baek 2025-06-16 15:16:29 +04:00 committed by GitHub
commit 0217c2d6a9
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 23 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
docs/features/chat-features/url-params.md
View File

@ -9,16 +9,17 @@ In Open WebUI, chat sessions can be customized through various URL parameters. T
The following table lists the available URL parameters, their function, and example usage.
| **Parameter** | **Description** | **Example** |
|-----------------------|----------------------------------------------------------------------------------|--------------------------------------------------------|
| `models` | Specifies the models to be used, as a comma-separated list. | `/?models=model1,model2` |
| `model` | Specifies a single model to be used for the chat session. | `/?model=model1` |
| `youtube` | Specifies a YouTube video ID to be transcribed within the chat. | `/?youtube=VIDEO_ID` |
| `web-search` | Enables web search functionality if set to `true`. | `/?web-search=true` |
| `tools` or `tool-ids` | Specifies a comma-separated list of tool IDs to activate in the chat. | `/?tools=tool1,tool2` |
| `call` | Enables a call overlay if set to `true`. | `/?call=true` |
| `q` | Sets an initial query or prompt for the chat. | `/?q=Hello%20there` |
| `temporary-chat` | Marks the chat as temporary if set to `true`, for one-time sessions. | `/?temporary-chat=true` |
| **Parameter** | **Description** | **Example** |
|-----------------------|-----------------------------------------------------------------------------------|----------------------------------|
| `models` | Specifies the models to be used, as a comma-separated list. | `/?models=model1,model2` |
| `model` | Specifies a single model to be used for the chat session. | `/?model=model1` |
| `youtube` | Specifies a YouTube video ID to be transcribed within the chat. | `/?youtube=VIDEO_ID` |
| `load_url` | Specifies a Website URL to be fetched and uploaded as a document within the chat. | `/?load_url=https://google.com` |
| `web-search` | Enables web search functionality if set to `true`. | `/?web-search=true` |
| `tools` or `tool-ids` | Specifies a comma-separated list of tool IDs to activate in the chat. | `/?tools=tool1,tool2` |
| `call` | Enables a call overlay if set to `true`. | `/?call=true` |
| `q` | Sets an initial query or prompt for the chat. | `/?q=Hello%20there` |
| `temporary-chat` | Marks the chat as temporary if set to `true`, for one-time sessions. | `/?temporary-chat=true` |
### 1. **Models and Model Selection**
@ -35,35 +36,42 @@ The following table lists the available URL parameters, their function, and exam
- **Example**: `/?youtube=VIDEO_ID`
- **Behavior**: This triggers transcription functionality within the chat for the provided YouTube video.
### 3. **Web Search**
### 3. **Website Insertion**
- **Description**: The `load_url` parameter downloads the specified website and extracts the content to upload it as a document into the chat.
- **How to Set**: Use the full website URL as the value for this parameter.
- **Example**: `/?load_url=https://google.com`
- **Behavior**: This triggers insertion of the specified website url.
### 4. **Web Search**
- **Description**: Enabling `web-search` allows the chat session to access [web search](/category/-web-search) functionality.
- **How to Set**: Set this parameter to `true` to enable web search.
- **Example**: `/?web-search=true`
- **Behavior**: If enabled, the chat can retrieve web search results as part of its responses.
### 4. **Tool Selection**
### 5. **Tool Selection**
- **Description**: The `tools` or `tool-ids` parameters specify which [tools](/features/plugin/tools) to activate within the chat.
- **How to Set**: Provide a comma-separated list of tool IDs as the parameter’s value.
- **Example**: `/?tools=tool1,tool2` or `/?tool-ids=tool1,tool2`
- **Behavior**: Each tool ID is matched and activated within the session for user interaction.
### 5. **Call Overlay**
### 6. **Call Overlay**
- **Description**: The `call` parameter enables a video or call overlay in the chat interface.
- **How to Set**: Set the parameter to `true` to enable the call overlay.
- **Example**: `/?call=true`
- **Behavior**: Activates a call interface overlay, allowing features such as live transcription and video input.
### 6. **Initial Query Prompt**
### 7. **Initial Query Prompt**
- **Description**: The `q` parameter allows setting an initial query or prompt for the chat.
- **How to Set**: Specify the query or prompt text as the parameter value.
- **Example**: `/?q=Hello%20there`
- **Behavior**: The chat starts with the specified prompt, automatically submitting it as the first message.
### 7. **Temporary Chat Sessions**
### 8. **Temporary Chat Sessions**
- **Description**: The `temporary-chat` parameter marks the chat as a temporary session. This may limit features such as saving chat history or applying persistent settings.
- **How to Set**: Set this parameter to `true` for a temporary chat session.