v34

latestOpenAPI 3.1.0raw.githubusercontent.com2026-06-09194386949.7 KB

Retrievers

Retrieve

Retrieve data using a Retriever.

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

retriever_idstring uuid required

project_idstring uuid nullable

organization_idstring uuid nullable

sessionstring nullable

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.

Successful Response