DocumentationAPI ReferenceChangelog

Envocal API

API Reference Tools guide MCP server API Changelog

Endpoints

List models GETGet a model GETList voices GETGet a voice GET
Models & voices

Get a voice

List voices GET

The voices the tenant's agents can speak with, in display order. An agent's voice is one of these keys, and it must work with the agent's model: pass model to get exactly the voices an agent on that model can use. Each voice has a short sample clip (sampleUrl).

List tools GET

The tools the tenant has made for its agents, newest first. Give a tool to an agent with PUT /v1/tenants/{tenantId}/agents/{id}/tools, using the tool's id.

GET
/v1/tenants/{tenantId}/voices/{key}

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.

key*string

Voice key, e.g. marin.

Response Body

The voice.

  1. response
  1. response
  2. …

A voice an agent can speak with.

key*string

The value to put in an agent's voice, e.g. marin.

name*string

Display name.

description?string

How the voice sounds or what it suits.

provider*

The company behind the voice.

gender*string

How the voice sounds.

Value in"female""male""neutral"
age?string

How old the voice sounds; null when not stated.

Value in"young""middle-aged""old"
language?string

The voice's primary language as a BCP 47 code without region (e.g. en); null when it has no primary language.

region?string

Region of the primary language (e.g. GB), if any.

accent?string

Accent or dialect of the primary language in words (e.g. London), if any.

multilingual?boolean

Whether the voice also speaks languages besides its primary language. Which ones, on a given model: those in the voice's languages that the model also speaks, or, when the voice's languages is empty, all the model's languages. When neither lists any, the voice isn't limited to a set of languages.

languages*array<string>

For a multilingual voice that speaks fewer languages than its model: the languages besides its primary language (BCP 47). Empty when it speaks all its model's languages.

tags*array<string>

Describing words, e.g. warm, calm.

sampleUrl?string

URL of a short sample clip (an audio file browsers can play, e.g. FLAC or MP3).

models*array<string>

Keys of the models that can speak with this voice.

status*string

preview, active or deprecated.

Value in"preview""active""deprecated"
Example Request
curl -X GET 'https://api.envocal.ai/v1/tenants/string/voices/string'
Example Response
{  "key": "string",  "name": "string",  "description": "string",  "provider": {    "key": "string",    "name": "string",    "logoUrl": "string"  },  "gender": "female",  "age": "young",  "language": "string",  "region": "string",  "accent": "string",  "multilingual": true,  "languages": [    "string"  ],  "tags": [    "string"  ],  "sampleUrl": "string",  "models": [    "string"  ],  "status": "preview"}
GET
/v1/tenants/{tenantId}/voices/{key}
Example Request
curl -X GET 'https://api.envocal.ai/v1/tenants/string/voices/string'
{
  "key": "string",
  "name": "string",
  "description": "string",
  "provider": {
    "key": "string",
    "name": "string",
    "logoUrl": "string"
  },
  "gender": "female",
  "age": "young",
  "language": "string",
  "region": "string",
  "accent": "string",
  "multilingual": true,
  "languages": [
    "string"
  ],
  "tags": [
    "string"
  ],
  "sampleUrl": "string",
  "models": [
    "string"
  ],
  "status": "preview"
}