Knowledge bases
Upload a file
POST
https://voxa.abhinavyadav.in/api/v1/knowledge-bases/{kb_id}/sources/fileA PDF, or a UTF-8 text or Markdown file (.txt, .md). It is processed in the background:
poll the knowledge base until the source is ready.
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
Path parameters
kb_idstringrequiredQuery 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 multipart/form-data
filefilerequiredResponse
201Success.
idstringkb_idstringkindenum<string>One of:fileurltext
namestringurlstringcontent_typestringsizeintegerdefault: 0statusenum<string>One of:processingreadyfailed
errorstringWhy processing failed, when status is failed.
chunk_countintegerdefault: 0charactersintegerdefault: 0created_atstringdate-time
processed_atstring | nulldate-time
created_bystring401No credentials, or they are invalid or revoked.
detailstringWhat went wrong, in plain words.
403Your role (or an API key) lacks the permission.
detailstringWhat went wrong, in plain words.
422Validation Error
detailobject[]Show item attributes
locstring | integer[]msgstringtypestring429Over the per-key rate limit; wait for Retry-After.
detailstringWhat went wrong, in plain words.