v8

latestOpenAPI 3.1.0Apache 2.0raw.githubusercontent.com2026-04-1592531.8 KB

Search

Searches the documents in a namespace.

Set multiturn: true to enable multi-turn mode, which returns a session_id and may return clarification_needed status when the system needs more information.

Set stream: true to receive results as server-sent events; see SearchStreamEvent for the event shape. The stream closes after either a session_result or error event.

post/v1/namespaces/{namespace}/search

Request body

objectivestring required

One sentence describing what you are looking for.

contextstring required

Additional context that helps the search system understand your intent. For example, relevant terminology, constraints, or prior knowledge.

streamboolean

Whether to stream the response as server-sent events.

include_attributesboolean

Whether to include document attributes in search results.

multiturnboolean

Enable multi-turn mode. When true, the response includes a session_id and may return clarification_needed status. When false (default), the search always completes in a single request.

Response

Successful response. When stream is false (default), returns JSON. When stream is true, returns text/event-stream.

session_idstring required

Unique identifier for this search session.

status'completed' | 'clarification_needed' | 'failed' required

documents_scannedinteger

Number of documents scanned during the search.

queries_executedinteger

Number of queries executed during the search.

synthesisstring required

Synthesized summary of all findings.