From 6c906b45bd3ffdbf973f43163d5c4933f47db8b9 Mon Sep 17 00:00:00 2001 From: "Timothy J. Baek" Date: Wed, 25 Sep 2024 14:11:46 +0200 Subject: [PATCH] refac --- docs/getting-started/api.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/getting-started/api.md b/docs/getting-started/api.md index d71fb18..2d18dbf 100644 --- a/docs/getting-started/api.md +++ b/docs/getting-started/api.md @@ -8,9 +8,9 @@ Welcome to the Open WebUI API! 🚀 This guide provides essential information on ## 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` - **Description**: Fetches all models created or added via Open WebUI. - **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 ``` -#### 💬 Chat Completions +### 💬 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. - **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. - **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.