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

Create a knowledge base

List knowledge bases of a tenant GET

Requires knowledge:read

Delete a knowledge base DELETE

Deletes the knowledge base and all its documents. Agents linked to it lose access.

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

An empty knowledge base; add documents with POST /v1/tenants/{tenantId}/knowledge-bases/{kbId}/documents and link it to agents.

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.

Request Body

The knowledge base.

  1. body
  1. body
  2. …

A new knowledge base.

name*string

Name, unique per tenant.

description?string

Optional description.

Response Body

Created.

  1. response
  1. response
  2. …

A knowledge base: a set of documents agents can search during conversations.

id*string

Knowledge base id.

name*string

Name, unique per tenant.

description?string

Optional description.

documentCount?integer

Number of documents.

Formatint32
tenantId*string

Tenant it belongs to.

Example Request
curl -X POST 'https://api.envocal.ai/v1/tenants/string/knowledge-bases' \  -H 'Content-Type: application/json' \  -d '{  "name": "string"}'
Example Response
{  "id": "string",  "name": "string",  "description": "string",  "documentCount": 0,  "tenantId": "string"}
Example Request
curl -X POST 'https://api.envocal.ai/v1/tenants/string/knowledge-bases' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "string"
}'
{
  "id": "string",
  "name": "string",
  "description": "string",
  "documentCount": 0,
  "tenantId": "string"
}