Skip to content

List voices

List system voices or your cloned voices; free.

POST/v1/get_voice

voice_type voice_cloning lists your cloned voices, system lists system voices, and all lists everything; voice_generation is always empty. Categories you did not request are null in the response.

Cloned voices include only voices in your account that were cloned successfully and have not been deleted or expired. You can also see system voices in System voices.

Headers

Authorization:requiredstring

Bearer sk-…: an API key created in the console under API keys; its group must include the requested model

Body parametersJSON

voice_type:requiredstring

Voice category to list

Valuessystemvoice_cloningvoice_generationall

Returns

200Voice list

system_voice:optionalarray of object or null

System voices; null if not requested

voice_cloning:optionalarray of object or null

Your cloned voices; null if not requested

voice_generation:optionalarray of object or null

Always an empty array; null if not requested

base_resp:optionalobject

{"status_code": 0, "status_msg": "success"} on success; errors do not come here but as a non-200 status code with an error object

Errors

400voice_type must be one of system, voice_cloning, voice_generation, all, or an unknown field is present
401Missing, invalid or expired API key (missing_api_key / invalid_api_key / api_key_expired)
413Request body over 64 KiB: request body is too large
503Voice or file registry temporarily unavailable; retry later (e.g. voice registry is temporarily unavailable; please retry)

Related