Skip to content

List agent voices

View .md
GET

The voices an agent can speak with, for voice.ttsVoiceId. Filter by language to get the ones that speak it; a voice can still be used with language: auto, where the agent follows the caller and keeps the chosen voice.

Authorization

  • Authorizationheaderrequired

    Bearer YOUR_API_KEY. Create a key in the dashboard.

Query parameters

  • languagestring

    BCP-47 tag (en, es, pt-BR). Omit, or pass auto, for every voice.

Responses

200Available voices.
  • itemsobject[]required
    3 properties
    • idstringrequired

      Value for voice.ttsVoiceId.

    • namestringrequired
    • languagestringrequired
  • languagesstring[]required

    Languages an agent can be pinned to. auto follows the caller.

  • totalinteger

    Voices in the catalog, before filtering.

401Unauthorized.
  • codestringrequired
  • messagestringrequired
  • detailsobject