ENDPOINTSVoices

Get voice

Returns metadata about a specific voice.

Path parameters

voice_idstringRequired

ID of the voice to be used. You can use the Get voices endpoint list all the available voices.

Headers

xi-api-keystringRequired

Query parameters

with_settingsbooleanOptionalDefaults to trueDeprecated
This parameter is now deprecated. It is ignored and will be removed in a future version.

Response

Successful Response
voice_idstring
The ID of the voice.
namestring or null
The name of the voice.
sampleslist of objects or null
List of samples associated with the voice.
categoryenum or null
The category of the voice.
Allowed values:
fine_tuningobject or null

Fine-tuning information for the voice.

labelsmap from strings to strings or null
Labels associated with the voice.
descriptionstring or null
The description of the voice.
preview_urlstring or null
The preview URL of the voice.
available_for_tierslist of strings or null
The tiers the voice is available for.
settingsobject or null
The settings of the voice.
sharingobject or null
The sharing information of the voice.
high_quality_base_model_idslist of strings or null

The base model IDs for high-quality voices.

verified_languageslist of objects or null
The verified languages of the voice.
safety_controlenum or null
The safety controls of the voice.
voice_verificationobject or null
The voice verification of the voice.
permission_on_resourcestring or null
The permission on the resource of the voice.
is_ownerboolean or null
Whether the voice is owned by the user.
is_legacyboolean or nullDefaults to false
Whether the voice is legacy.
is_mixedboolean or nullDefaults to false
Whether the voice is mixed.
created_at_unixinteger or null
The creation time of the voice in Unix time.

Errors