Skip to main content
GET
Get knowledge base status

Authorizations

Authorization
string
header
default:<auth-token>
required

Your API token, sent raw (no Bearer prefix).

Path Parameters

knowledgeId
string
required

Response

The current status.

knowledgeId
string
status
enum<string>
  • processing: being parsed and indexed. Not available to agents yet.
  • ready: indexed and available to agents.
  • failed: processing stopped. statusReason says why.
Available options:
processing,
ready,
failed
statusReason
string | null

Why processing failed.

failureCode
string | null

For example upload_failed or job_not_scheduled.

updatedAt
string<date-time>
sizeInBytes
integer | null
pageCount
integer | null
sectionCount
integer | null