Skip to content
VoxaDocs
Navigation
Open console →

Knowledge bases

Get a knowledge base

GET/api/v1/knowledge-bases/{kb_id}

One knowledge base with its sources and their processing status.

Authorization

An API key (X-API-Key or Authorization: Bearer), or a signed-in member with the agents.view permission.

X-API-KeyAuthorization: Beareragents.view

Path parameters

kb_idstringrequired

Query parameters

timezonestringdefault: "Asia/Kolkata"

IANA time zone for every timestamp in the response (at, date, timestamp and *_at fields), as ISO 8601 with the offset. The X-Timezone header works too; the zone used comes back in the X-Timezone response header. An unknown zone is a 400.

Response

200Success.
idstring
namestring
descriptionstring
source_countintegerdefault: 0

Sources of any status.

chunk_countintegerdefault: 0

Searchable passages (from ready sources).

sizeintegerdefault: 0

Bytes of the uploaded files and fetched pages.

processingintegerdefault: 0

Sources still being processed.

agentsobject[]

Agents that search it during calls.

Show item attributes
idstring
namestring
created_atstring

date-time

updated_atstring

date-time

created_bystring
sourcesobject[]

Newest first.

Show item attributes
idstring
kb_idstring
kindenum<string>

One of:fileurltext

namestring
urlstring
content_typestring
sizeintegerdefault: 0
statusenum<string>

One of:processingreadyfailed

errorstring

Why processing failed, when status is failed.

chunk_countintegerdefault: 0
charactersintegerdefault: 0
created_atstring

date-time

processed_atstring | null

date-time

created_bystring
401No credentials, or they are invalid or revoked.
detailstring

What went wrong, in plain words.

403Your role (or an API key) lacks the permission.
detailstring

What went wrong, in plain words.

422Validation Error
detailobject[]
Show item attributes
locstring | integer[]
msgstring
typestring
429Over the per-key rate limit; wait for Retry-After.
detailstring

What went wrong, in plain words.

Esc