Skip to main content
POST

Authorizations

Authorization
string
header
required

Tenant-scoped API key beginning with qkv_live_.

Path Parameters

index_id
string<uuid>
required

Tenant-scoped index UUID returned by index creation.

Body

application/json
query
string
required

Non-empty query, at most 8 KiB encoded as UTF-8.

Minimum string length: 1
top_k
integer
default:10

Maximum final results returned.

Required range: 1 <= x <= 100
candidate_k
integer
default:100

Retrieval breadth considered before final ranking.

Required range: 1 <= x <= 500
filter
object

Exact matches on top-level metadata fields.

return_components
boolean
default:false

Include optional diagnostic component scores when available.

Response

Ranked search results, which may be empty

results
object[]
required

Results ordered by descending final score.

usage
object
required