DocumentationAPI ReferenceChangelog

Envocal API

API Reference API Changelog

Endpoints

List knowledge bases of a tenant GETCreate a knowledge base POSTDelete a knowledge base DELETERename or describe a knowledge base PUTList documents in a knowledge base GETUpload a document POSTDelete a document DELETEGet processing status of documents POST
Knowledge bases

Upload a document

List documents in a knowledge base GET

Requires knowledge:read

Delete a document DELETE

Requires knowledge:write

POST
/v1/tenants/{tenantId}/knowledge-bases/{kbId}/documents

Send multipart/form-data with the document in a file field (e.g. PDF, Word, plain text or Markdown), one document per request, at most 20 MB. The document is processed in the background: poll POST /v1/tenants/{tenantId}/knowledge-bases/{kbId}/documents/status with the returned id until its state is complete.

Required permission: knowledge:write

Authorization

Bearer
headerAuthorizationBearer <token>

Tenant API key (evk_…), created in Studio → Vault → API keys.

Path Parameters

tenantId*string

Tenant id, or current for the key's own tenant. Must be the key's tenant or one of its sub-tenants.

kbId*string

Knowledge base id.

Request Body

multipart/form-data
  1. body
  1. body
  2. …
file?file
Formatbinary

Response Body

Accepted for processing. Body: { "id": "<document id>" }.

Example Request
curl -X POST 'https://api.envocal.ai/v1/tenants/string/knowledge-bases/string/documents'
Example Response
Empty
Example Request
curl -X POST 'https://api.envocal.ai/v1/tenants/string/knowledge-bases/string/documents'