provider voices GET
/v2/voices @utdk/elevenlabs
/v2/voices Get Voices V2
Gets a list of all available voices for a user with search, filtering and pagination.
- next_page_token query
- The next page token to use for pagination. Returned from the previous request. Use this in combination with the has_more flag for reliable pagination.
- page_size query
- 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.
- integer
- search query
- Search term to filter voices by. Searches in name, description, labels, category.
- sort query
- Which field to sort by, one of 'created_at_unix' or 'name'. 'created_at_unix' may not be available for older voices.
- sort_direction query
- Which direction to sort the voices in. 'asc' or 'desc'.
- voice_type query
- Type of the voice to filter by. One of 'personal', 'community', 'default', 'workspace', 'non-default', 'non-community', 'saved'. 'non-default' is equal to all but 'default'. 'non-community' is equal to 'personal' and 'workspace' combined (excludes library copies). 'saved' is equal to non-default, but includes default voices if they have been added to a collection.
- category query
- Category of the voice to filter by. One of 'premade', 'cloned', 'generated', 'professional'
- fine_tuning_state query
- 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 query
- Collection ID to filter voices by.
- include_total_count query
- Whether to include the total count of voices found in the response. NOTE: The total_count value is a live snapshot and may change between requests as users create, modify, or delete voices. For pagination, rely on the has_more flag instead. Only enable this when you actually need the total count (e.g., for display purposes), as it incurs a performance cost.
- boolean
- voice_ids query
- Voice IDs to lookup by. Maximum 100 voice IDs.
- xi-api-key header
- Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.
Try it
Authentication
Configure credentials for ElevenLabs API Documentation
Code snippet
Updates live as you fill in the form above.
TypeScript
import elevenlabs from '@utdk/elevenlabs';
await elevenlabs.getUserVoicesV2({
"page_size": 10,
"include_total_count": true
})