Open Web UI icon

Open Web UI

OpenWebUI

Actions304

Retrieval → query_collection_handler_api_v1_retrieval_query_collection_post

AI-generated

Summary

Send a POST request to query specified collections in the Open Web UI Retrieval API, returning data based on the query parameters provided.

Inputs

  • Skip Authentication — Set to true to skip authentication for this request (default is false).
  • Authentication (required) — Defines the authentication method using OpenWebUI Auth; hidden and not user-editable unless Skip Authentication is false.
  • Method (required) — HTTP method to use; for this operation, typically POST.
  • Request Body (required) — Parameters to specify collections to query and query details including:
  • collection_names: Array of collection names (string) to search in (required).
  • query: The search query string (required).
  • k: Optional integer parameter.
  • r: Optional number parameter.
  • hybrid: Optional boolean to indicate hybrid query mode.
  • Media Type (required) — Content type for the request, fixed to application/json for this operation.

Output shape

a JSON object response from the Open Web UI Retrieval API reflecting the query results

The response shape depends on the API implementation and is not explicitly described; the operation performs a POST to '/api/v1/retrieval/query/collection' and returns the resulting JSON data. Authentication is required unless explicitly skipped.

Links

Discussion