API ReferenceKnowledge BasesKnowledge bases

Search Knowledge Bases

Beta

Semantic search across a caller-owned list of knowledge bases. Returns ranked chunks with source filename and a cosine-similarity score. Limited to 50 results per request.

Authentication

AuthorizationBearer

Enter your API key with the Bearer prefix, e.g. ‘Bearer sk_…’.

Headers

Speechify-VersionstringOptional

Request

This endpoint expects an object.
querystringRequired

Natural-language search query.

kb_idslist of stringsRequired

Knowledge bases to search across. Results scoped to caller-owned entries; unknown IDs are silently ignored.

limitintegerOptionalDefaults to 5

Max hits to return (default 5, capped at 50).

Response headers

Speechify-Request-IdstringOptional
Unique identifier for this request, present on every response (2xx and non-2xx alike). If the caller sends a `Speechify-Request-Id` request header the server echoes it back (sanitized and length-capped) so one logical request can be traced end-to-end; otherwise the server generates a fresh value. Log it on every response and quote it in support requests - it is the stable handle that ties your observation to Speechify's server-side logs, and it matches the `request_id` field in the error envelope. The legacy alias `X-Request-ID` carries the same value and is still accepted on requests, until 2027-07-24. Prefer the un-prefixed name (RFC 6648).

Response

Ranked search hits across the selected knowledge bases.
hitslist of objects
coverageenum

Retrieval’s verdict on whether the evidence it found answers the question. sufficient: answer from the hits. partial: something related was found; answer with care. insufficient: nothing found clears even the low bar, and the honest answer is that the knowledge base does not cover this; the agent’s search_knowledge tool then reports no relevant context rather than the weak hits.

retrieval_versionstring
The retrieval contract that produced this result, so results can be compared like with like across a rollout.

Errors

400
Bad Request Error
401
Unauthorized Error