Skip to content
VoxaDocs
Navigation
Open console →

Knowledge bases

Create a knowledge base

POST/api/v1/knowledge-bases

An empty knowledge base; add sources to it, then attach it to agents.

Authorization

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

X-API-KeyAuthorization: Beareragents.edit

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.

Body application/json

namestringrequired

1 to 120 characters

descriptionstring

at most 1000 characters

Response

201Success.
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
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