Voices
Get Voices
- Documentation
- API Reference
- Python Library
- Community
- Getting Started
- How to use text to speech
- Combining multiple generations
- How to use pronunciation dictionaries
- How to use the text to sound effects API
- How to dub a video
- Integrating with Twilio
- Reducing Latency
- How to use websocket
- POSTText To Speech
- POSTText To Speech With Timestamps
- POSTStreaming
- POSTText To Speech Streaming With Timestamps
- Websockets
- POSTSound Generation
- GETGet Generated Items
- GETGet History Item By Id
- DELDelete History Item
- GETGet Audio From History Item
- POSTDownload History Items
- GETGet Voices
- GETGet Default Voice Settings.
- GETGet Voice Settings
- GETGet Voice
- DELDelete Voice
- POSTEdit Voice Settings
- POSTAdd Voice
- POSTEdit Voice
- GETGet Projects
- GETGet Project By Id
- POSTAdd Project
- DELDelete Project
- POSTConvert Project
- GETGet Project Snapshots
- POSTStream Project Audio
- GETGet Chapters
- GETGet Chapter By Id
- DELDelete Chapter
- POSTConvert Chapter
- GETGet Chapter Snapshots
- POSTStream Chapter Audio
- POSTUpdate Pronunciation Dictionaries
- POSTAdd from file
- GETGet dictionaries
- GETGet dictionary by id
- POSTAdd rules
- POSTRemove rules
- GETDownload version by id
- GETGet Models
- POSTCreates Audionative Enabled Project.
Guides
Text to Speech
Sound Effects
History
Voices
Projects
Pronunciation Dictionaries
Models
Audio-native
Voices
Get Voices
Gets a list of all available voices for a user.
GET
/
v1
/
voices
xi-api-key
Xi-Api-Key · string
xi-api-key
string
Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.
show_legacy
Show Legacy · boolean
show_legacy
boolean
If set to true, legacy premade voices will be included in responses from /v1/voices
Headers
xi-api-key
string
Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.
Query Parameters
show_legacy
boolean
default: falseIf set to true, legacy premade voices will be included in responses from /v1/voices
Response
200 - application/json
voices
object[]
requiredvoices.voice_id
string
requiredvoices.name
string
requiredvoices.samples
object[]
requiredvoices.samples.sample_id
string
requiredvoices.samples.file_name
string
requiredvoices.samples.mime_type
string
requiredvoices.samples.size_bytes
integer
requiredvoices.samples.hash
string
requiredvoices.category
string
requiredvoices.fine_tuning
object
requiredvoices.fine_tuning.is_allowed_to_fine_tune
boolean
requiredvoices.fine_tuning.state
object
requiredvoices.fine_tuning.verification_failures
string[]
requiredvoices.fine_tuning.verification_attempts_count
integer
requiredvoices.fine_tuning.manual_verification_requested
boolean
requiredvoices.fine_tuning.language
string
voices.fine_tuning.progress
object
voices.fine_tuning.message
object
voices.fine_tuning.dataset_duration_seconds
number
voices.fine_tuning.verification_attempts
object[]
voices.fine_tuning.verification_attempts.text
string
requiredvoices.fine_tuning.verification_attempts.date_unix
integer
requiredvoices.fine_tuning.verification_attempts.accepted
boolean
requiredvoices.fine_tuning.verification_attempts.similarity
number
requiredvoices.fine_tuning.verification_attempts.levenshtein_distance
number
requiredvoices.fine_tuning.verification_attempts.recording
object
voices.fine_tuning.verification_attempts.recording.recording_id
string
requiredvoices.fine_tuning.verification_attempts.recording.mime_type
string
requiredvoices.fine_tuning.verification_attempts.recording.size_bytes
integer
requiredvoices.fine_tuning.verification_attempts.recording.upload_date_unix
integer
requiredvoices.fine_tuning.verification_attempts.recording.transcription
string
requiredvoices.fine_tuning.slice_ids
string[]
voices.fine_tuning.manual_verification
object
voices.fine_tuning.manual_verification.extra_text
string
requiredvoices.fine_tuning.manual_verification.request_time_unix
integer
requiredvoices.fine_tuning.manual_verification.files
object[]
requiredvoices.fine_tuning.manual_verification.files.file_id
string
requiredvoices.fine_tuning.manual_verification.files.file_name
string
requiredvoices.fine_tuning.manual_verification.files.mime_type
string
requiredvoices.fine_tuning.manual_verification.files.size_bytes
integer
requiredvoices.fine_tuning.manual_verification.files.upload_date_unix
integer
requiredvoices.labels
object
requiredvoices.description
string
requiredvoices.preview_url
string
requiredvoices.available_for_tiers
string[]
requiredvoices.settings
object
requiredvoices.settings.stability
number
requiredvoices.settings.similarity_boost
number
requiredvoices.settings.style
number
default: 0voices.settings.use_speaker_boost
boolean
default: truevoices.sharing
object
requiredvoices.sharing.status
enum<string>
requiredAvailable options:
enabled, disabled, copied, copied_disabled voices.sharing.history_item_sample_id
string
requiredvoices.sharing.date_unix
integer
requiredvoices.sharing.whitelisted_emails
string[]
requiredvoices.sharing.public_owner_id
string
requiredvoices.sharing.original_voice_id
string
requiredvoices.sharing.financial_rewards_enabled
boolean
requiredvoices.sharing.free_users_allowed
boolean
requiredvoices.sharing.live_moderation_enabled
boolean
requiredvoices.sharing.rate
number
requiredvoices.sharing.notice_period
integer
requiredvoices.sharing.disable_at_unix
integer
requiredvoices.sharing.voice_mixing_allowed
boolean
requiredvoices.sharing.featured
boolean
requiredvoices.sharing.category
enum<string>
requiredAvailable options:
generated, professional, high_quality, famous voices.sharing.reader_app_enabled
boolean
requiredvoices.sharing.image_url
string
requiredvoices.sharing.ban_reason
string
requiredvoices.sharing.liked_by_count
integer
requiredvoices.sharing.cloned_by_count
integer
requiredvoices.sharing.name
string
requiredvoices.sharing.description
string
requiredvoices.sharing.labels
object
requiredvoices.sharing.review_status
enum<string>
requiredAvailable options:
not_requested, pending, declined, allowed, allowed_with_changes voices.sharing.review_message
string
requiredvoices.sharing.enabled_in_library
boolean
requiredvoices.sharing.instagram_username
string
voices.sharing.twitter_username
string
voices.sharing.youtube_username
string
voices.sharing.tiktok_username
string
voices.high_quality_base_model_ids
string[]
requiredvoices.safety_control
enum<string>
Available options:
NONE, BAN, CAPTCHA, CAPTCHA_AND_MODERATION voices.voice_verification
object
voices.voice_verification.requires_verification
boolean
requiredvoices.voice_verification.is_verified
boolean
requiredvoices.voice_verification.verification_failures
string[]
requiredvoices.voice_verification.verification_attempts_count
integer
requiredvoices.voice_verification.language
string
voices.voice_verification.verification_attempts
object[]
voices.voice_verification.verification_attempts.text
string
requiredvoices.voice_verification.verification_attempts.date_unix
integer
requiredvoices.voice_verification.verification_attempts.accepted
boolean
requiredvoices.voice_verification.verification_attempts.similarity
number
requiredvoices.voice_verification.verification_attempts.levenshtein_distance
number
requiredvoices.voice_verification.verification_attempts.recording
object
voices.voice_verification.verification_attempts.recording.recording_id
string
requiredvoices.voice_verification.verification_attempts.recording.mime_type
string
requiredvoices.voice_verification.verification_attempts.recording.size_bytes
integer
requiredvoices.voice_verification.verification_attempts.recording.upload_date_unix
integer
requiredvoices.voice_verification.verification_attempts.recording.transcription
string
requiredvoices.owner_id
string
voices.permission_on_resource
string
voices.is_legacy
boolean
default: false