List voices

List the text-to-speech voices and providers available to voice assistants. Use a voice's provider, model_id, voice_id and id to fill voice_provider, voice_provider_model, voice_id and voice_model in telnyx_ai_assistant_config. The catalog is read from the voice provider and cached for 30 minutes; it is the same for every organization.

Endpoint

GET
/telnyx-ai-voices

Query parameters

NameTypeRequiredDescription
providerstringNoOnly voices of this provider, e.g. telnyx, aws, azure, minimax, elevenlabs.
api_key_refstringNoFor bring-your-own-key providers (elevenlabs, rime): the voice_api_key_ref stored on one of your assistants, so the account's own voices are listed.
providers_onlybooleanNotrue returns only providers and language_boost_values, with an empty data.

Request

Voices of a bring-your-own-key provider already configured on an assistant:

To list the voices of a provider key that is not stored yet, send it in a JSON body with

POST
/telnyx-ai-voices (provider and api_key). The key is only used for this lookup. To keep it, send it as telnyx_ai_assistant_config.voice_api_key when you update the assistant.

Response

json
FieldDescription
providers[].requires_api_keyThe provider only lists and speaks voices with your own provider key.
providers[].accepts_api_keyThe provider can use your own key (stored with voice_api_key).
language_boost_valuesAccepted values of voice_language_boost.

Errors

StatusWhen
400The provider rejected the request (for example an invalid provider key). The body has the usual shape with an empty data and an error message.

Report an issue with this documentation

Please log in to report issues with our documentation.