Sign in

v1

latestOpenAPI 3.0.12026-07-2210997354.2 KB
Voices

List voices

Lists all voices available to your organization.

get/organization/voices

Query parameters

filter[language.id]string

filter by language id

filter[speaker.id]string

filter by speaker id

filter[language.code]string

filter by language code

filter[additional]boolean

filter by additional voices

filter[scopes][]string[]
filter[types][]string[]

filter by voice types

filter[statuses][]string[]

filter by voice statuses

filter[preview_statuses][]string[]

filter by preview status of the voice for its primary language

filter[custom]boolean

filter by custom voices

Response

OK

idinteger

Unique identifier for the object

namestring

The name of the voice

type'premade' | 'instant' | 'professional' | 'generated'

The type of the voice

status'draft' | 'recording' | 'processing' | 'review' | 'enabled' | 'deprecated' | 'disabled' | 'unavailable'

The status of the voice

preview_statuses'processing' | 'processed'

The preview status of the voice for its primary language

script_idsinteger[]

The script IDs associated with the voice

speaking_rateinteger

The speaking rate of the voice

multilingual_modeboolean
expressivenessnumber nullable
use_speaker_boostboolean nullable
similarity_boostnumber nullable
stylenumber nullable
cloning_consentstring nullable

The cloning consent URL for instant and professional voices

clone_errorsobject[]

An array of voice cloning errors in the standard error format

createdstring date-time

Time at which the object was created (ISO 8601)

updatedstring date-time

Time at which the object was updated (ISO 8601)

logo_patterninteger nullable

Logo pattern number

logo_color'red' | 'green' | 'blue' | 'purple' | 'gray' | 'pink' | 'cyan' nullable

Logo pattern color

gender'male' | 'female' | 'neutral' nullable

The gender of the voice

languagestring

The language of the voice

secondary_languagesstring[]

The secondary languages of the voice

servicestring

The source of the voice

model_idstring nullable
preview_urlstring nullable

The preview URL of the voice

premiumboolean

Whether the voice is premium or not

exclusiveboolean

Whether the voice is exclusive or not

customboolean

The custom flag of the voice

additionalboolean
pauses_supportedboolean