DocumentationAPI ReferenceChangelog

Envocal API

API Reference API Changelog

Endpoints

List agents of a tenant GETCreate an agent POSTGet an agent GETDelete an agent DELETEUpdate an agent PUTAssign a phone number to an agent POSTUnassign an agent's phone number DELETEList an agent's knowledge bases GETLink a knowledge base to an agent POSTUnlink a knowledge base from an agent DELETEList agent templates GETCreate an agent from a template POST
Agents

List an agent's knowledge bases

Unassign an agent's phone number DELETE

Requires agents:write

Link a knowledge base to an agent POST

The agent can then search the knowledge base during conversations. The knowledge base must belong to the agent's tenant.

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

Required permission: agents: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.

id*string

Agent id.

Response Body

Linked knowledge bases (empty list if none).

  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/agents/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/agents/string/knowledge-bases'
[
  {
    "id": "string",
    "name": "string",
    "description": "string",
    "documentCount": 0,
    "tenantId": "string"
  }
]