v34

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

Retrieval

Retrieve

Retrieve relevant chunks via hybrid search (vector + full-text), with filtering on built-in or user-defined metadata.

post/api/v1/retrieval/retrieve

project_idstring uuid nullable

organization_idstring uuid nullable

sessionstring nullable

index_idstring required

ID of the index to retrieve against.

querystring required

Natural-language query to retrieve relevant chunks.

top_kinteger nullable

Maximum number of results to return.

num_candidatesinteger nullable

Number of candidates for approximate nearest neighbor search.

vector_pipeline_weightnumber nullable

Weight of the vector search pipeline (0-1).

full_text_pipeline_weightnumber nullable

Weight of the full-text search pipeline (0-1).

score_thresholdnumber nullable

Minimum score threshold for returned results.

custom_filtersobject nullable

Filters on user-defined metadata fields.

{
  "index_id": "idx-abc123",
  "query": "What are the key findings?",
  "top_k": 10,
  "rerank": {
    "top_n": 5
  }
}

Successful Response