Agents

List agent voices

Lists the voices an agent can speak with: public voices and voices assigned to your project. Use a voice's id as voice_id when you create or update an agent. This is a different list from GET /api/ext/tts/voices, which holds the text-to-speech voices for speech generation; those IDs are not accepted as an agent's voice_id.

GET

https://api.nabrah.ai/api/ext/agent/voices

List agent voices

curl --request GET \
  --url 'https://api.nabrah.ai/api/ext/agent/voices' \
  --header 'X-API-Key: <your-api-key>'

[
  {
    "id": "00000000-0000-4000-8000-000000000000",
    "name": "string",
    "description": "string",
    "voice_country": "SA",
    "voice_gender": "male",
    "is_local": false
  }
]

Response fields

Returns an array of voices.

id

The voice ID to send as voice_id on Create Agent or Update Agent.

id

name and description

The voice's display name and a short description of how it sounds.

namedescription

voice_country and voice_gender

The accent's country and the voice's gender, to help you pick a voice that fits your callers.

voice_countryvoice_gender

is_local

true for voices with a local accent.

is_local

Authorization

X-API-Keystringheaderrequired

Your workspace API key. Create one in the dashboard under API keys.

Response

200

Successful Response

application/json