Skip to main content
POST
Search knowledge sources

Headers

x-project-id
string<uuid>
required

Project ID for tenant scoping

X-Workspace-Id
string<uuid> | null

Overrides the key's workspace

X-API-Key
string | null

User API key

Query Parameters

query
string
required

Search text to match against knowledge source content.

top_k
integer
default:5

Maximum number of matched chunks to return.

generate_answer
boolean
default:true

If True, also return a generated answer; if False, return raw matched chunks only.

Body

application/json
source_ids
string<uuid>[] | null
folder_ids
string<uuid>[] | null
tag_ids
string<uuid>[] | null
workflow_status
string[] | null

Response

Successful Response

Retrieval response. answer is null in chunks-only mode.

query_id
string<uuid> | null
chunks
Chunk · object[]
citations
Citation · object[]
answer
string | null
reasoning
string
default:""
usage_instruction
string
default:""
strategy
string
default:SIMPLE
leafmerger_rolled_up
boolean
default:false
bm25_fired
boolean
default:false
cache_hit
boolean
default:false