Open Web UI icon

Open Web UI

OpenWebUI

Actions304

Retrieval → query_doc_handler_api_v1_retrieval_query_doc_post

AI-generated

Summary

Send a POST request to the /api/v1/retrieval/query/doc endpoint to query a document retrieval service with specific parameters.

Inputs

  • Skip Authentication — A boolean to skip authentication; defaults to false.
  • Method — HTTP method for the request; defaults to POST for this operation.
  • Media Type — Specifies the media type of the request body; must be application/json.
  • Request Body (required) — An object containing: 'collection_name' (string, required) to specify which collection to query, 'query' (string, required) as the search text, and optional parameters 'k' (integer or null), 'r' (number or null), and 'hybrid' (boolean or null) to customize the query behavior.

Output shape

a JSON object response from the document retrieval API containing the query results

The response format depends on the backend service; the operation sends a JSON POST request and expects a JSON response. Authentication is applied unless skipped.

Links

Discussion