curl --request POST \
--url https://embed.breadbowl.ai/v1/indexes/{index_id}/search \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"query": "How do I rotate an API key?"
}
'{
"results": [
{
"doc_id": "help-center:api-keys",
"chunk_id": "chk_000003",
"chunk_index": 3,
"score": 0.82,
"metadata": {
"source": "help-center",
"locale": "en",
"status": "published"
}
}
],
"usage": {
"input_tokens": 9,
"document_count": 0,
"chunk_count": 1,
"candidate_count": 42,
"latency_ms": 96
}
}Search an index
Returns relevance-ranked chunk references from one index. Original source text is not included; hydrate documents from your own datastore using doc_id.
The optional filter performs exact matches against top-level metadata fields. Filters are not an authorization boundary.
POST
/
v1
/
indexes
/
{index_id}
/
search
curl --request POST \
--url https://embed.breadbowl.ai/v1/indexes/{index_id}/search \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"query": "How do I rotate an API key?"
}
'{
"results": [
{
"doc_id": "help-center:api-keys",
"chunk_id": "chk_000003",
"chunk_index": 3,
"score": 0.82,
"metadata": {
"source": "help-center",
"locale": "en",
"status": "published"
}
}
],
"usage": {
"input_tokens": 9,
"document_count": 0,
"chunk_count": 1,
"candidate_count": 42,
"latency_ms": 96
}
}Authorizations
Tenant-scoped API key beginning with qkv_live_.
Path Parameters
Tenant-scoped index UUID returned by index creation.
Body
application/json
Non-empty query, at most 8 KiB encoded as UTF-8.
Minimum string length:
1Maximum final results returned.
Required range:
1 <= x <= 100Retrieval breadth considered before final ranking.
Required range:
1 <= x <= 500Exact matches on top-level metadata fields.
Include optional diagnostic component scores when available.