List voices
Gets a list of all available voices for a user with search, filtering and pagination.
Headers
xi-api-key
Query parameters
next_page_token
The next page token to use for pagination. Returned from the previous request.
page_size
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.
search
Search term to filter voices by. Searches in name, description, labels, category.
sort
Which field to sort by, one of ‘created_at_unix’ or ‘name’. ‘created_at_unix’ may not be available for older voices.
sort_direction
Which direction to sort the voices in. 'asc' or 'desc'.
voice_type
Type of the voice to filter by. One of ‘personal’, ‘community’, ‘default’, ‘workspace’, ‘non-default’. ‘non-default’ is equal to all but ‘default’.
category
Category of the voice to filter by. One of 'premade', 'cloned', 'generated', 'professional'
fine_tuning_state
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_id
Collection ID to filter voices by.
include_total_count
Whether to include the total count of voices found in the response. Incurs a performance cost.
Response
Successful Response
voices
has_more
total_count
next_page_token