ENDPOINTSVoices

List voices

Gets a list of all available voices for a user with search, filtering and pagination.

Headers

xi-api-keystringOptional

Query parameters

next_page_tokenstringOptional

The next page token to use for pagination. Returned from the previous request.

page_sizeintegerOptionalDefaults to 10

How many voices to return at maximum. Can not exceed 100, defaults to 10. Page 0 may include more voices due to default voices being included.

searchstringOptional

Search term to filter voices by. Searches in name, description, labels, category.

sortstringOptional

Which field to sort by, one of ‘created_at_unix’ or ‘name’. ‘created_at_unix’ may not be available for older voices.

sort_directionstringOptional

Which direction to sort the voices in. ‘asc’ or ‘desc’.

voice_typestringOptional

Type of the voice to filter by. One of ‘personal’, ‘community’, ‘default’, ‘workspace’, ‘non-default’. ‘non-default’ is equal to ‘personal’ plus ‘community’.

categorystringOptional

Category of the voice to filter by. One of ‘premade’, ‘cloned’, ‘generated’, ‘professional’

fine_tuning_statestringOptional

State of the voice’s fine tuning to filter by. Applicable only to professional voices clones. One of ‘draft’, ‘not_verified’, ‘not_started’, ‘queued’, ‘fine_tuning’, ‘fine_tuned’, ‘failed’, ‘delayed’

collection_idstringOptional

Collection ID to filter voices by.

include_total_countbooleanOptionalDefaults to true

Whether to include the total count of voices found in the response. Incurs a performance cost.

Response

Successful Response

voiceslist of objects
has_moreboolean
total_countinteger
next_page_tokenstringOptional

Errors