Developers / Agents

List voices an agent can use

GET https://api.echonova.ai/v1/agent-voices

Lists 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

Authorization string Required

Bearer, a space, then your API key, which starts with ek_. Create keys in the portal under Developers, API Keys.

Query parameters

offset integer Optional

How many items to skip.

0 to 10000default 0
limit integer Optional

How many items to return.

1 to 50default 20
dialect string Optional

Only voices of this dialect.

Up to 50 characters
gender string Optional

Only voices of this gender, for example female or male.

Up to 20 characters
q string Optional

Only voices whose name contains this text.

Up to 100 characters

Response

200 application/json Every response uses this envelope.

data object

The result.

success boolean

true for a successful call.

statusCode integer

Repeats the HTTP status.

errorMessage string or null

null on success.

Errors

Same envelope, with success false and data null. All errors

GET /v1/agent-voices

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
}