Voices
Get Voice
- Documentation
- API Reference
- Python Library
- Community
- Getting Started
- How to use text to speech
- Combining multiple generations
- How to use pronunciation dictionaries
- How to dub a video
- Integrating with Twilio
- Reducing Latency
- 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
History
Voices
Projects
Pronunciation Dictionaries
Models
Audio-native
Voices
Get Voice
Returns metadata about a specific voice.
GET
/
v1
/
voices
/
{voice_id}
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.
voice_id
Voice Id · string
*
voice_id
Required
string
Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices.
with_settings
With Settings · boolean
with_settings
boolean
If set will return settings information corresponding to the voice, requires authorization.
curl --request GET \
--url https://api.elevenlabs.io/v1/voices/{voice_id}
{
"voice_id": "<string>",
"name": "<string>",
"samples": [
{
"sample_id": "<string>",
"file_name": "<string>",
"mime_type": "<string>",
"size_bytes": 123,
"hash": "<string>"
}
],
"category": "<string>",
"fine_tuning": {
"is_allowed_to_fine_tune": true,
"finetuning_state": "not_started",
"verification_failures": [
"<string>"
],
"verification_attempts_count": 123,
"manual_verification_requested": true,
"language": "<string>",
"finetuning_progress": {},
"message": "<string>",
"dataset_duration_seconds": 123,
"verification_attempts": [
{
"text": "<string>",
"date_unix": 123,
"accepted": true,
"similarity": 123,
"levenshtein_distance": 123,
"recording": {
"recording_id": "<string>",
"mime_type": "<string>",
"size_bytes": 123,
"upload_date_unix": 123,
"transcription": "<string>"
}
}
],
"slice_ids": [
"<string>"
],
"manual_verification": {
"extra_text": "<string>",
"request_time_unix": 123,
"files": [
{
"file_id": "<string>",
"file_name": "<string>",
"mime_type": "<string>",
"size_bytes": 123,
"upload_date_unix": 123
}
]
}
},
"labels": {},
"description": "<string>",
"preview_url": "<string>",
"available_for_tiers": [
"<string>"
],
"settings": {
"stability": 123,
"similarity_boost": 123,
"style": 123,
"use_speaker_boost": true
},
"sharing": {
"status": "enabled",
"history_item_sample_id": "<string>",
"date_unix": 123,
"whitelisted_emails": [
"<string>"
],
"public_owner_id": "<string>",
"original_voice_id": "<string>",
"financial_rewards_enabled": true,
"free_users_allowed": true,
"live_moderation_enabled": true,
"rate": 123,
"notice_period": 123,
"disable_at_unix": 123,
"voice_mixing_allowed": true,
"featured": true,
"category": "generated",
"reader_app_enabled": true,
"ban_reason": "<string>",
"liked_by_count": 123,
"cloned_by_count": 123,
"name": "<string>",
"description": "<string>",
"labels": {},
"review_status": "not_requested",
"review_message": "<string>",
"enabled_in_library": true,
"instagram_username": "<string>",
"twitter_username": "<string>",
"youtube_username": "<string>",
"tiktok_username": "<string>"
},
"high_quality_base_model_ids": [
"<string>"
],
"safety_control": "NONE",
"voice_verification": {
"requires_verification": true,
"is_verified": true,
"verification_failures": [
"<string>"
],
"verification_attempts_count": 123,
"language": "<string>",
"verification_attempts": [
{
"text": "<string>",
"date_unix": 123,
"accepted": true,
"similarity": 123,
"levenshtein_distance": 123,
"recording": {
"recording_id": "<string>",
"mime_type": "<string>",
"size_bytes": 123,
"upload_date_unix": 123,
"transcription": "<string>"
}
}
]
},
"owner_id": "<string>",
"permission_on_resource": "<string>"
}
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.
Path Parameters
voice_id
string
requiredVoice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices.
Query Parameters
with_settings
boolean
default: falseIf set will return settings information corresponding to the voice, requires authorization.
Response
200 - application/json
voice_id
string
requiredname
string
requiredsamples
object[]
requiredsamples.sample_id
string
requiredsamples.file_name
string
requiredsamples.mime_type
string
requiredsamples.size_bytes
integer
requiredsamples.hash
string
requiredcategory
string
requiredfine_tuning
object
requiredfine_tuning.is_allowed_to_fine_tune
boolean
requiredfine_tuning.finetuning_state
enum<string>
requiredAvailable options:
not_started
, queued
, fine_tuning
, fine_tuned
, failed
, delayed
fine_tuning.verification_failures
string[]
requiredfine_tuning.verification_attempts_count
integer
requiredfine_tuning.manual_verification_requested
boolean
requiredfine_tuning.language
string
fine_tuning.finetuning_progress
object
fine_tuning.message
string
fine_tuning.dataset_duration_seconds
number
fine_tuning.verification_attempts
object[]
fine_tuning.verification_attempts.text
string
requiredfine_tuning.verification_attempts.date_unix
integer
requiredfine_tuning.verification_attempts.accepted
boolean
requiredfine_tuning.verification_attempts.similarity
number
requiredfine_tuning.verification_attempts.levenshtein_distance
number
requiredfine_tuning.verification_attempts.recording
object
fine_tuning.verification_attempts.recording.recording_id
string
requiredfine_tuning.verification_attempts.recording.mime_type
string
requiredfine_tuning.verification_attempts.recording.size_bytes
integer
requiredfine_tuning.verification_attempts.recording.upload_date_unix
integer
requiredfine_tuning.verification_attempts.recording.transcription
string
requiredfine_tuning.slice_ids
string[]
fine_tuning.manual_verification
object
fine_tuning.manual_verification.extra_text
string
requiredfine_tuning.manual_verification.request_time_unix
integer
requiredfine_tuning.manual_verification.files
object[]
requiredfine_tuning.manual_verification.files.file_id
string
requiredfine_tuning.manual_verification.files.file_name
string
requiredfine_tuning.manual_verification.files.mime_type
string
requiredfine_tuning.manual_verification.files.size_bytes
integer
requiredfine_tuning.manual_verification.files.upload_date_unix
integer
requiredlabels
object
requireddescription
string
requiredpreview_url
string
requiredavailable_for_tiers
string[]
requiredsettings
object
requiredsettings.stability
number
requiredsettings.similarity_boost
number
requiredsettings.style
number
default: 0settings.use_speaker_boost
boolean
default: truesharing
object
requiredsharing.status
enum<string>
requiredAvailable options:
enabled
, disabled
, copied
, copied_disabled
sharing.history_item_sample_id
string
requiredsharing.date_unix
integer
requiredsharing.whitelisted_emails
string[]
requiredsharing.public_owner_id
string
requiredsharing.original_voice_id
string
requiredsharing.financial_rewards_enabled
boolean
requiredsharing.free_users_allowed
boolean
requiredsharing.live_moderation_enabled
boolean
requiredsharing.rate
number
requiredsharing.notice_period
integer
requiredsharing.disable_at_unix
integer
requiredsharing.voice_mixing_allowed
boolean
requiredsharing.featured
boolean
requiredsharing.category
enum<string>
requiredAvailable options:
generated
, professional
, high_quality
sharing.reader_app_enabled
boolean
requiredsharing.ban_reason
string
requiredsharing.liked_by_count
integer
requiredsharing.cloned_by_count
integer
requiredsharing.name
string
requiredsharing.description
string
requiredsharing.labels
object
requiredsharing.review_status
enum<string>
requiredAvailable options:
not_requested
, pending
, declined
, allowed
, allowed_with_changes
sharing.review_message
string
requiredsharing.enabled_in_library
boolean
requiredsharing.instagram_username
string
sharing.twitter_username
string
sharing.youtube_username
string
sharing.tiktok_username
string
high_quality_base_model_ids
string[]
requiredsafety_control
enum<string>
Available options:
NONE
, BAN
, CAPTCHA
, CAPTCHA_AND_MODERATION
voice_verification
object
voice_verification.requires_verification
boolean
requiredvoice_verification.is_verified
boolean
requiredvoice_verification.verification_failures
string[]
requiredvoice_verification.verification_attempts_count
integer
requiredvoice_verification.language
string
voice_verification.verification_attempts
object[]
voice_verification.verification_attempts.text
string
requiredvoice_verification.verification_attempts.date_unix
integer
requiredvoice_verification.verification_attempts.accepted
boolean
requiredvoice_verification.verification_attempts.similarity
number
requiredvoice_verification.verification_attempts.levenshtein_distance
number
requiredvoice_verification.verification_attempts.recording
object
voice_verification.verification_attempts.recording.recording_id
string
requiredvoice_verification.verification_attempts.recording.mime_type
string
requiredvoice_verification.verification_attempts.recording.size_bytes
integer
requiredvoice_verification.verification_attempts.recording.upload_date_unix
integer
requiredvoice_verification.verification_attempts.recording.transcription
string
requiredowner_id
string
permission_on_resource
string
curl --request GET \
--url https://api.elevenlabs.io/v1/voices/{voice_id}
{
"voice_id": "<string>",
"name": "<string>",
"samples": [
{
"sample_id": "<string>",
"file_name": "<string>",
"mime_type": "<string>",
"size_bytes": 123,
"hash": "<string>"
}
],
"category": "<string>",
"fine_tuning": {
"is_allowed_to_fine_tune": true,
"finetuning_state": "not_started",
"verification_failures": [
"<string>"
],
"verification_attempts_count": 123,
"manual_verification_requested": true,
"language": "<string>",
"finetuning_progress": {},
"message": "<string>",
"dataset_duration_seconds": 123,
"verification_attempts": [
{
"text": "<string>",
"date_unix": 123,
"accepted": true,
"similarity": 123,
"levenshtein_distance": 123,
"recording": {
"recording_id": "<string>",
"mime_type": "<string>",
"size_bytes": 123,
"upload_date_unix": 123,
"transcription": "<string>"
}
}
],
"slice_ids": [
"<string>"
],
"manual_verification": {
"extra_text": "<string>",
"request_time_unix": 123,
"files": [
{
"file_id": "<string>",
"file_name": "<string>",
"mime_type": "<string>",
"size_bytes": 123,
"upload_date_unix": 123
}
]
}
},
"labels": {},
"description": "<string>",
"preview_url": "<string>",
"available_for_tiers": [
"<string>"
],
"settings": {
"stability": 123,
"similarity_boost": 123,
"style": 123,
"use_speaker_boost": true
},
"sharing": {
"status": "enabled",
"history_item_sample_id": "<string>",
"date_unix": 123,
"whitelisted_emails": [
"<string>"
],
"public_owner_id": "<string>",
"original_voice_id": "<string>",
"financial_rewards_enabled": true,
"free_users_allowed": true,
"live_moderation_enabled": true,
"rate": 123,
"notice_period": 123,
"disable_at_unix": 123,
"voice_mixing_allowed": true,
"featured": true,
"category": "generated",
"reader_app_enabled": true,
"ban_reason": "<string>",
"liked_by_count": 123,
"cloned_by_count": 123,
"name": "<string>",
"description": "<string>",
"labels": {},
"review_status": "not_requested",
"review_message": "<string>",
"enabled_in_library": true,
"instagram_username": "<string>",
"twitter_username": "<string>",
"youtube_username": "<string>",
"tiktok_username": "<string>"
},
"high_quality_base_model_ids": [
"<string>"
],
"safety_control": "NONE",
"voice_verification": {
"requires_verification": true,
"is_verified": true,
"verification_failures": [
"<string>"
],
"verification_attempts_count": 123,
"language": "<string>",
"verification_attempts": [
{
"text": "<string>",
"date_unix": 123,
"accepted": true,
"similarity": 123,
"levenshtein_distance": 123,
"recording": {
"recording_id": "<string>",
"mime_type": "<string>",
"size_bytes": 123,
"upload_date_unix": 123,
"transcription": "<string>"
}
}
]
},
"owner_id": "<string>",
"permission_on_resource": "<string>"
}