Sign in
Retrievers

Direct Retrieve

Retrieve data using specified pipelines without creating a persistent retriever.

post/api/v1/retrievers/retrieve

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

Changed in 1 of the 33 revisions of this API.2

  • b17341164de92See the full diff
    • ○

      added the optional property detail/items/ctx to the response with the 422 status

      response-optional-property-added

    • ○

      added the optional property detail/items/input to the response with the 422 status

      response-optional-property-added

    This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog