Get voice

GET
/v1/voices/:voice_id

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.

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
namestringOptional
sampleslist of objectsOptional
categoryenumOptional
fine_tuningobjectOptional
labelsmap from strings to stringsOptional
descriptionstringOptional
preview_urlstringOptional
available_for_tierslist of stringsOptional
settingsobjectOptional
sharingobjectOptional
high_quality_base_model_idslist of stringsOptional
safety_controlenumOptional
voice_verificationobjectOptional
permission_on_resourcestringOptional
is_ownerbooleanOptional
is_legacybooleanOptionalDefaults to false
is_mixedbooleanOptionalDefaults to false
created_at_unixintegerOptional

Errors

Built with