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

List knowledge bases of a tenant

Create an agent from a template POST

Copies the template's instructions, variables and voice settings into a new draft agent in the tenant, with a default widget configuration whose settings are all unset (the widget's defaults apply). Phone number, knowledge bases and tools are not copied.

Create a knowledge base POST

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

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

Required permission: knowledge:read

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.

Response Body

The knowledge bases.

  1. response
  1. response
  2. …
[index: integer]?

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

Example Request
curl -X GET 'https://api.envocal.ai/v1/tenants/string/knowledge-bases'
Example Response
[  {    "id": "string",    "name": "string",    "description": "string",    "documentCount": 0,    "tenantId": "string"  }]
Example Request
curl -X GET 'https://api.envocal.ai/v1/tenants/string/knowledge-bases'
[
  {
    "id": "string",
    "name": "string",
    "description": "string",
    "documentCount": 0,
    "tenantId": "string"
  }
]