OpenWebUI/docs
1
0
Fork 0
mirror of https://github.com/open-webui/docs synced 2025-05-20 03:08:56 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

refac

Browse Source
This commit is contained in:
Timothy J. Baek 2024-09-25 14:11:46 +02:00
parent 99131d6ff4
commit b0b2f5cca9
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/getting-started/api.md
View File

@ -8,9 +8,9 @@ Welcome to the Open WebUI API! 🚀 This guide provides essential information on
## Authentication ## Authentication
To ensure secure access to the API, authentication is required 🛡️. You can authenticate your API requests using the Bearer Token mechanism. Obtain your API key from **Settings > Account** in the Open WebUI, or alternatively, use a JWT (JSON Web Token) for authentication. To ensure secure access to the API, authentication is required 🛡️. You can authenticate your API requests using the Bearer Token mechanism. Obtain your API key from **Settings > Account** in the Open WebUI, or alternatively, use a JWT (JSON Web Token) for authentication.
### Notable API Endpoints ## Notable API Endpoints
#### 📜 Retrieve All Models ### 📜 Retrieve All Models
- **Endpoint**: `GET /api/models` - **Endpoint**: `GET /api/models`
- **Description**: Fetches all models created or added via Open WebUI. - **Description**: Fetches all models created or added via Open WebUI.
- **Example**: - **Example**:
@ -18,7 +18,7 @@ To ensure secure access to the API, authentication is required 🛡️. You can
curl -H "Authorization: Bearer YOUR_API_KEY" http://localhost:3000/api/models curl -H "Authorization: Bearer YOUR_API_KEY" http://localhost:3000/api/models
``` ```
#### 💬 Chat Completions ### 💬 Chat Completions
- **Endpoint**: `POST /api/chat/completions` - **Endpoint**: `POST /api/chat/completions`
- **Description**: Serves as an OpenAI API compatible chat completion endpoint for models on Open WebUI including Ollama models, OpenAI models, and Open WebUI Function models. - **Description**: Serves as an OpenAI API compatible chat completion endpoint for models on Open WebUI including Ollama models, OpenAI models, and Open WebUI Function models.
- **Example**: - **Example**:
@ -37,7 +37,7 @@ To ensure secure access to the API, authentication is required 🛡️. You can
}' }'
``` ```
#### 🧩 Retrival Augmented Generation (RAG) ### 🧩 Retrival Augmented Generation (RAG)
- **Endpoint Info**: Currently available with limited functionality as it undergoes significant refinements. Use of the RAG API remains possible but certain operations may be limited until the integration of our ongoing improvements. - **Endpoint Info**: Currently available with limited functionality as it undergoes significant refinements. Use of the RAG API remains possible but certain operations may be limited until the integration of our ongoing improvements.
- **Note**: Anticipate enhanced functionality upon completion of [Issue #3527](https://github.com/open-webui/open-webui/issues/3527). We're working hard to streamline processes and include exciting new features. Thank you for your patience as we ensure that the RAG API will be easier and more efficient to use. - **Note**: Anticipate enhanced functionality upon completion of [Issue #3527](https://github.com/open-webui/open-webui/issues/3527). We're working hard to streamline processes and include exciting new features. Thank you for your patience as we ensure that the RAG API will be easier and more efficient to use.