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

Delete an agent

Get an agent GET

The agent's settings. Use GET /v1/agents/{id}/full to also get its knowledge bases and tools expanded.

Update an agent PUT

Replaces the agent's settings. Send the version you read; it changes on every update. Voice settings left null keep their current value. knowledgeBaseIds: null keeps the current links, [] removes all, a list replaces them. The tenant cannot be changed.

DELETE
/v1/tenants/{tenantId}/agents/{id}

Deletes the agent and its widget configurations and tool assignments. Its phone number becomes unassigned. Past conversations are kept.

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

id*string

Agent id.

Response Body

Deleted.

Example Request
curl -X DELETE 'https://api.envocal.ai/v1/tenants/string/agents/string'
Example Response
Empty
Example Request
curl -X DELETE 'https://api.envocal.ai/v1/tenants/string/agents/string'