From 044161d07d4458efd361b4a0b0c469fcc8f8e0aa Mon Sep 17 00:00:00 2001 From: Classic298 <27028174+Classic298@users.noreply.github.com> Date: Fri, 13 Nov 2026 11:30:27 +0100 Subject: [PATCH 1/3] Note that API endpoints are no longer documented The API endpoints page now says that endpoints change too often to document and recommends pointing an AI agent at the backend to read the latest endpoints and specs. A tip box in the environment variable reference was left open and is now closed. --- docs/reference/api-endpoints.md | 4 ++++ docs/reference/env-configuration.mdx | 1 + 2 files changed, 5 insertions(+) diff --git a/docs/reference/api-endpoints.md b/docs/reference/api-endpoints.md index b3db4214cd..ed566d60be 100644 --- a/docs/reference/api-endpoints.md +++ b/docs/reference/api-endpoints.md @@ -5,6 +5,10 @@ title: "API Endpoints" This guide provides essential information on how to interact with the API endpoints effectively to achieve seamless integration and automation using our models. Please note that this is an experimental setup and may undergo future updates for enhancement. +:::note Endpoints are not documented any more +The API changes so often that new endpoints, request fields and socket events are no longer documented here. To find the latest endpoints and specs, point an AI agent at the Open WebUI backend and let it read them. The endpoints below stay for reference. +::: + ## 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. For full instructions on enabling and generating API keys (including the admin toggle and group permissions required for non-admin users) see [API Keys](/features/authentication-access/api-keys). diff --git a/docs/reference/env-configuration.mdx b/docs/reference/env-configuration.mdx index 151184a47f..6fd4723eaa 100644 --- a/docs/reference/env-configuration.mdx +++ b/docs/reference/env-configuration.mdx @@ -4807,6 +4807,7 @@ Only increase this variable's value if it does. Otherwise you might run into une #### `RAG_EMBEDDING_BUFFER_SIZE` - Type: `int` +::: - Default: `1000` - Description: Number of chunks embedded and saved to the vector database per step while a document is processed. Rounded up to a whole multiple of [`RAG_EMBEDDING_BATCH_SIZE`](#rag_embedding_batch_size). Must be a positive integer. From bb9cf2169aa103c0a288bcef00b14a9db901196b Mon Sep 17 00:00:00 2001 From: Classic298 <27028174+Classic298@users.noreply.github.com> Date: Fri, 13 Nov 2026 11:59:02 +0100 Subject: [PATCH 2/3] Reword the API endpoints note The note now says the API changes so often that documenting it makes little sense, and still recommends pointing an AI agent at the backend for the latest endpoints and specs. --- docs/reference/api-endpoints.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/reference/api-endpoints.md b/docs/reference/api-endpoints.md index ed566d60be..57cce1de10 100644 --- a/docs/reference/api-endpoints.md +++ b/docs/reference/api-endpoints.md @@ -6,7 +6,7 @@ title: "API Endpoints" This guide provides essential information on how to interact with the API endpoints effectively to achieve seamless integration and automation using our models. Please note that this is an experimental setup and may undergo future updates for enhancement. :::note Endpoints are not documented any more -The API changes so often that new endpoints, request fields and socket events are no longer documented here. To find the latest endpoints and specs, point an AI agent at the Open WebUI backend and let it read them. The endpoints below stay for reference. +The API changes so often that documenting it makes little sense. To find the latest endpoints and specs, point an AI agent at the Open WebUI backend and let it read them. The endpoints below stay for reference. ::: ## Authentication From 83574d44790bf1a98f447b88c95202292ead0886 Mon Sep 17 00:00:00 2001 From: Classic298 <27028174+Classic298@users.noreply.github.com> Date: Fri, 13 Nov 2026 12:00:28 +0100 Subject: [PATCH 3/3] Fix the note box placement and the endpoints note wording The closing line of the open tip box in the environment variable reference now sits after the tip text. The API endpoints note is reworded. --- docs/reference/api-endpoints.md | 2 +- docs/reference/env-configuration.mdx | 3 ++- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/reference/api-endpoints.md b/docs/reference/api-endpoints.md index 57cce1de10..3888c537a0 100644 --- a/docs/reference/api-endpoints.md +++ b/docs/reference/api-endpoints.md @@ -6,7 +6,7 @@ title: "API Endpoints" This guide provides essential information on how to interact with the API endpoints effectively to achieve seamless integration and automation using our models. Please note that this is an experimental setup and may undergo future updates for enhancement. :::note Endpoints are not documented any more -The API changes so often that documenting it makes little sense. To find the latest endpoints and specs, point an AI agent at the Open WebUI backend and let it read them. The endpoints below stay for reference. +The API changes often and documenting it makes little sense. To find the latest endpoints and specs, point an AI agent at the Open WebUI backend and let it read them. The endpoints below stay for reference. ::: ## Authentication diff --git a/docs/reference/env-configuration.mdx b/docs/reference/env-configuration.mdx index 6fd4723eaa..57ae8e99b6 100644 --- a/docs/reference/env-configuration.mdx +++ b/docs/reference/env-configuration.mdx @@ -4807,7 +4807,6 @@ Only increase this variable's value if it does. Otherwise you might run into une #### `RAG_EMBEDDING_BUFFER_SIZE` - Type: `int` -::: - Default: `1000` - Description: Number of chunks embedded and saved to the vector database per step while a document is processed. Rounded up to a whole multiple of [`RAG_EMBEDDING_BATCH_SIZE`](#rag_embedding_batch_size). Must be a positive integer. @@ -4822,6 +4821,8 @@ Only increase this variable's value if it does. Otherwise you might run into une It may be needed to increase the value of `THREAD_POOL_SIZE` if many other users are simultaneously using your Open WebUI instance while having async embeddings turned on to prevent +::: + :::warning Enabling this will potentially send thousands of requests per minute.