Skip to main content
POST
Search knowledge cards

Authorizations

Authorization
string
header
required

Pass your API key as a Bearer token. Example: Authorization: Bearer sk-xxxxxxxxxxxx

Path Parameters

id
integer
required

Collection ID

Body

application/json
query
string
required

The search query string

Example:

"What are the main risk factors?"

top_k
integer
default:10

Number of results to return

Required range: 1 <= x <= 100
rerank
boolean
default:false

Whether to apply cross-encoder reranking to results

current_only
boolean
default:false

Restrict search to the most current document versions only

filters
object

Optional metadata filters to narrow the search scope

Example:

Response

Search results

results
object[]
total_results
integer

Number of results returned

query_time_ms
number

Time taken to execute the search in milliseconds

tokens_used
object

Token usage breakdown