Developers / Agents
List voices an agent can use
https://api.echonova.ai/v1/agent-voicesLists the active EchoNova voices and this workspace's cloned voices, paged with offset and limit. Pass an id as voiceId in voices when you create or update an agent. Needs the agents:read scope on the key.
Headers
Bearer, a space, then your API key, which starts with ek_. Create keys in the portal under Developers, API Keys.
Query parameters
How many items to skip.
How many items to return.
Only voices of this dialect.
Only voices of this gender, for example female or male.
Only voices whose name contains this text.
Response
200 application/json Every response uses this envelope.
The result.
The items on this page.
The voice id. Pass it as voiceId in voices.
The voice key name.
The name to show, in English and Arabic.
The name in English.
The name in Arabic.
The dialect it speaks.
The voice gender.
The voice language.
public for EchoNova voices, cloned for this workspace's clones.
The total number of items.
true for a successful call.
Repeats the HTTP status.
null on success.
Errors
Same envelope, with success false and data null. All errors
When. offset on a jobs list is negative.
Fix. Send 0 or more.
When. offset is not a whole number.
Fix. Send an integer.
When. offset on a list is above 10000.
Fix. Send 0 to 10000.
When. limit is below 1.
Fix. Send 1 or more.
When. limit on a list or transcript is above 50.
Fix. Send 1 to 50, and page with offset (or before for a transcript).
When. limit is not a number at all.
Fix. Send an integer from 1 to 50.
When. The body or query carries a field the endpoint does not define.
Fix. Remove the field.
When. q is over 100 characters.
Fix. Send a shorter search.
When. The Authorization header is missing or is not Bearer ek_..., no key matches the token, or the key is deleted, disabled, expired or its account is closed.
Fix. Send Authorization: Bearer ek_... with an enabled key from this environment.
When. The workspace that owns the key has no subscription.
Fix. Check the workspace's plan in the portal.
When. The subscription is in a state other than active or trial.
Fix. Renew the subscription.
When. The key does not have the agents:read scope. Speech and widget ticket access do not give it.
Fix. Edit the key and give it the agents:read scope, or use another key.
When. The member who created the key has left the workspace, or no longer has both the View agents and Manage developer API permissions. It is checked on every call.
Fix. Give that member both permissions again, or create a key as a member who has them.
When. The key made more than 100 requests to one endpoint in 60 seconds, or one IP address made more than 100 requests to one endpoint in 60 seconds (the IP limit is counted before the key is checked, so it can answer with no key at all); a Retry-After header carries the seconds to wait.
Fix. Wait Retry-After seconds, then retry.
When. An error the API did not classify.
Fix. Check the request, then retry after a short wait; contact support if it persists.
When. A transient outage inside the API.
Fix. Retry after a short wait.
When. A transient timeout inside the API.
Fix. Retry after a short wait.
curl "https://api.echonova.ai/v1/agent-voices" \
-H "Authorization: Bearer YOUR_API_KEY"{
"data": {
"items": [
{
"id": "6640a1b2c3d4e5f6a7b8c9d0",
"name": "huda",
"displayName": {
"en": "Huda",
"ar": "هدى"
},
"dialect": "emirati",
"gender": "female",
"language": "ar",
"type": "public"
}
],
"total": 1
},
"success": true,
"statusCode": 200,
"errorMessage": null
}