v9

latestOpenAPI 3.0.3raw.githubusercontent.com2026-08-0151715.4 KB

Pipelines

Query pipeline

Execute a RAG query against a specific pipeline

post/pipelines/{name}

Path parameters

namestring required

Pipeline name

Request body

disable_hybridboolean

Skip the keyword-search arm for this request, using vector search alone. Reduces latency and database work. This can only turn hybrid search off: a request cannot enable it where the pipeline configuration has disabled it.

include_sourcesboolean

Request the source documents used to produce the answer. Honoured only if the pipeline is configured with allow_include_sources: true; otherwise the answer is returned without sources and the request still succeeds.

querystring required

The question to answer

streamboolean

Enable streaming response (SSE)

top_ninteger

Override default result limit

Response

Query response

answerstring required

The generated answer

tokens_usedinteger required

Total tokens consumed