Create Knowledge Base

Beta
Create a new knowledge base.

Authentication

AuthorizationBearer

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

Headers

Speechify-VersionstringOptional

Request

This endpoint expects an object.
namestringRequired

Human-readable label.

descriptionstringOptional
Optional description.

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.

Response

The created knowledge base.
idstringformat: "^kb_[0-9a-hjkmnp-tv-z]{26}$"

Prefixed wire identifier (kb_<26 char Crockford base32>).

namestring

Human-readable label for the knowledge base.

descriptionstring
Optional description.
document_countinteger
Number of ingested documents.
created_atdatetime
updated_atdatetime

Errors

400
Bad Request Error
401
Unauthorized Error