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 agent templates

Unlink a knowledge base from an agent DELETE

The knowledge base itself is not deleted.

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.

GET
/v1/tenants/{tenantId}/agent-templates

Templates (agents with isTemplate true) that the tenant can use: its own and those of its parent tenants.

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.

Response Body

The templates, sorted by name.

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

An agent template that can be instantiated.

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