Skip to main content
POST
Retrieve Knowledge

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
query
string | null

The question to search the knowledge bases with

entity_names
string[] | null

Metadata tags to pre-filter on, written as "key:value" (for example ["model:SY500"]). Prefix matched and ANDed

enable_toc_enhance
boolean | null
default:false

Enable table-of-contents enhanced retrieval

knowledge_ids
string[] | null

Knowledge bases to search, resolved within the API key's organization

pre_filter_document_ids
string[] | null

Restrict the search to these documents; intersected with the entity_names filter when both are used

return_metadata
boolean | null
default:true

Include each document's entity_names in the response

Response

Successful Response

documents
DocumentInfo · object[] | null

Documents the retrieved passages came from

document_contents
string | null

Retrieved passages serialised as JSON, shortened by a model when over the context budget