API ReferenceKnowledge BasesDocuments

List Knowledge Base Documents

Beta

List documents ingested into a knowledge base. Cursor-paginated: omit cursor to fetch the first page. Default page size is 50 and max is 200. Walk pages while has_more is true.

Authentication

AuthorizationBearer

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

Path parameters

kb_idstringRequired

Knowledge base id (prefixed external id, kb_...).

Headers

Speechify-VersionstringOptional

Query parameters

folder_idstringOptional

Folder filter: omit for root-level documents, pass all for every document in the KB, or a folder id to scope to that folder.

qstringOptional

Substring match on filename and source_url.

source_kindstringOptional

Comma-separated source kinds (file|url|text).

cursorstringOptional
Opaque pagination cursor from a previous response.
limitintegerOptional1-200Defaults to 50

Max items per page (default 50, max 200).

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 documents in the knowledge base.
next_cursorstring or null

Opaque keyset cursor for the next page. Pass back as the cursor request parameter. null when the caller has reached the end of the list (has_more is also false in that case).

has_moreboolean
True when more rows exist beyond this page.
documentslist of objects

Errors

401
Unauthorized Error
404
Not Found Error