Open Web UI icon

Open Web UI

OpenWebUI

Actions304

Retrieval → update_embedding_config_api_v1_retrieval_embedding_update_post

AI-generated

Summary

Update the embedding configuration for the Retrieval resource by sending a POST request to /api/v1/retrieval/embedding/update with specified embedding engine, model, optional batch size, and optional OpenAI or Ollama configuration details.

Inputs

  • Skip Authentication — If true, bypasses authentication for this operation.
  • Authentication (required) — Authentication credentials for Open WebUI (hidden unless Skip Authentication is enabled).
  • Method (required) — HTTP method to use for the request (default is POST).
  • Media Type (required) — Content type of the request payload, fixed to application/json.
  • Request Body (required) — Collection of parameters including embedding_engine (string, required), embedding_model (string, required), optional embedding_batch_size (integer), optional openai_config (object with url and key), and optional ollama_config (object with url and key).

Output shape

a single JSON object response from the API

The operation sends a POST request to the fixed endpoint /api/v1/retrieval/embedding/update on the Open Web UI instance defined by the baseUrl or credential. The response data shape depends on the API's implementation and is returned directly. Authentication is required unless Skip Authentication is enabled.

Links

Discussion