Sign in
Retrievers

Retrieve

Retrieve data using a Retriever.

post/api/v1/retrievers/{retriever_id}/retrieve

Request

  • The document declares no server URL.
  • Auth: HTTP bearer

Path parameters

retriever_idstring uuid required

Query parameters

project_idstring uuid nullable
organization_idstring uuid nullable

Cookies

sessionstring nullable

Request body

mode'routing' | 'full'

Enum for the mode of composite retrieval.

rerank_top_ninteger nullable

(use rerank_config.top_n instead) The number of nodes to retrieve after reranking over retrieved nodes from all retrieval tools.

querystring required

The query to retrieve against.

Response

Successful Response

Changes

No recorded changes to this operation across all 6 revisions of this API.