v1

latestOpenAPI 3.1.02026-07-2671117149.2 KB
Apis

List Voices

get/list-voices

Response

Successful Response

idinteger

A unique identifier for the voice record. This ID serves as the primary reference when using the voice in other API operations.

voice_namestring

The name or label assigned to the voice. For public voices, this typically indicates the voice character (e.g., 'Sarah' or 'Michael'). For custom voices, this is the name you provided during creation.

genderinteger nullable

Represents the gender of the voice, encoded as an integer value. Common values include 1 for male and 2 for female, though other values may be used to represent non-binary or other gender identities.

ageinteger nullable

The approximate age of the voice, represented as an integer. This helps you select voices that match your desired demographic characteristics. May be null if age information is not available.

descriptionstring nullable

A brief summary describing the custom voice's characteristics—such as its tone, emotional quality, or intended use cases. This field provides context beyond the basic demographic information. May be null for voices without descriptions.

transcriptstring nullable

The transcribed text of the source recording used to create custom voices. This can be helpful to understand the vocal range and quality demonstrated in the original sample. May be null if no transcript is available.

is_publishedboolean nullable

Indicates whether the voice is shared on the marketplace (true) or private to your account (false). This allows you to identify shared voices that others can access.

languagestring