Skip to main content

GET/1.0/knowledge-bases/:id

Reads one knowledge base — the summary fields plus the live-revision pointer and resolved ingestion settings. Required scope: workbench:knowledge_bases:read (scopes reference).

Path parameters

idstringRequired

The knowledge base id, from GET /1.0/knowledge-bases or the create response.

Response

The full knowledge-base record. Notable fields beyond the list summary:

currentRevisionIdstring | null

The live content snapshot. null until the first ingestion completes.

statusstring

empty · ingesting · ready · failed. Poll this after adding documents — when it returns to ready, search reflects the new content.

Returns 404 not_found when the id doesn't exist in the key's workspace; an id from another workspace also returns 404 not_found.

1 min read