Search Knowledge Bases | Speechify API

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_…’.

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

X-Request-IDstring

Unique identifier for this request, present on every response (2xx and non-2xx alike). If the caller sends an X-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.

Unique identifier for this request, present on every response (2xx and non-2xx alike). If the caller sends an `X-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.

Response

Ranked search hits across the selected knowledge bases.

hitslist of objects

Errors

400

Bad Request Error

401

Unauthorized Error

$	curl -X POST https://api.speechify.ai/v1/agents/knowledge-bases/search \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"query": "example",
>	"kb_ids": [
>	"kb_01jqr8x9zg5k2m3n4p5q6r7s8t"
>	],
>	"limit": 50
>	}'

1	{
2	"hits": [
3	{
4	"chunk_id": "chunk_01jqr8x9zg5k2m3n4p5q6r7s8t",
5	"document_id": "doc_01jqr8x9zg5k2m3n4p5q6r7s8t",
6	"kb_id": "kb_01jqr8x9zg5k2m3n4p5q6r7s8t",
7	"filename": "example",
8	"chunk_index": 1,
9	"content": "example",
10	"score": 1
11	}
12	]
13	}

Authentication

Headers

Request

Response headers

Response

Errors