Get voice

GET

/v1/voices/:voice_id

GET

1 from elevenlabs import ElevenLabs
2 
3 client = ElevenLabs(
4     api_key="YOUR_API_KEY",
5 )
6 client.voices.get(
7     voice_id="JBFqnCBsd6RMkjVDRZzb",
8 )

Try it

1 {
2   "voice_id": "21m00Tcm4TlvDq8ikWAM",
3   "name": "Rachel",
4   "category": "professional",
5   "labels": {
6     "accent": "American",
7     "age": "middle-aged",
8     "description": "expressive",
9     "gender": "female",
10     "use_case": "social media"
11   },
12   "available_for_tiers": [
13     "creator",
14     "enterprise"
15   ],
16   "high_quality_base_model_ids": [
17     "eleven_v2_flash",
18     "eleven_flash_v2",
19     "eleven_turbo_v2_5",
20     "eleven_multilingual_v2",
21     "eleven_v2_5_flash",
22     "eleven_flash_v2_5",
23     "eleven_turbo_v2"
24   ],
25   "samples": [
26     {
27       "sample_id": "DCwhRBWXzGAHq8TQ4Fs18",
28       "file_name": "sample.mp3",
29       "mime_type": "audio/mpeg",
30       "size_bytes": 1000000,
31       "hash": "1234567890",
32       "duration_secs": 1.1,
33       "remove_background_noise": true,
34       "has_isolated_audio": true,
35       "has_isolated_audio_preview": true,
36       "speaker_separation": {
37         "voice_id": "voice_id",
38         "sample_id": "sample_id",
39         "status": "not_started"
40       }
41     }
42   ],
43   "fine_tuning": {
44     "is_allowed_to_fine_tune": true,
45     "state": {
46       "eleven_multilingual_v2": "fine_tuned"
47     },
48     "verification_failures": [
49       "verification_failures"
50     ],
51     "verification_attempts_count": 2,
52     "manual_verification_requested": false,
53     "language": "language",
54     "progress": {
55       "key": 1.1
56     },
57     "message": {
58       "key": "value"
59     },
60     "dataset_duration_seconds": 1.1,
61     "verification_attempts": [
62       {
63         "text": "Hello, how are you?",
64         "date_unix": 1714204800,
65         "accepted": true,
66         "similarity": 0.95,
67         "levenshtein_distance": 2,
68         "recording": {
69           "recording_id": "CwhRBWXzGAHq8TQ4Fs17",
70           "mime_type": "audio/mpeg",
71           "size_bytes": 1000000,
72           "upload_date_unix": 1714204800,
73           "transcription": "Hello, how are you?"
74         }
75       }
76     ],
77     "slice_ids": [
78       "slice_ids"
79     ],
80     "manual_verification": {
81       "extra_text": "Please verify the voice is that of a female.",
82       "request_time_unix": 1714204800,
83       "files": [
84         {
85           "file_id": "CwhRBWXzGAHq8TQ4Fs18",
86           "file_name": "file.mp3",
87           "mime_type": "audio/mpeg",
88           "size_bytes": 1000000,
89           "upload_date_unix": 1714204800
90         }
91       ]
92     },
93     "max_verification_attempts": 1,
94     "next_max_verification_attempts_reset_unix_ms": 1
95   },
96   "description": "A warm, expressive voice with a touch of humor.",
97   "preview_url": "https://storage.googleapis.com/eleven-public-prod/premade/voices/9BWtsMINqrJLrRacOk9x/405766b8-1f4e-4d3c-aba1-6f25333823ec.mp3",
98   "settings": {
99     "stability": 1,
100     "similarity_boost": 1,
101     "style": 0,
102     "use_speaker_boost": true,
103     "speed": 1
104   },
105   "sharing": {
106     "status": "enabled",
107     "date_unix": 1714204800,
108     "whitelisted_emails": [
109       "example@example.com"
110     ],
111     "public_owner_id": "DCwhRBWXzGAHq8TQ4Fs18",
112     "original_voice_id": "DCwhRBWXzGAHq8TQ4Fs18",
113     "financial_rewards_enabled": true,
114     "free_users_allowed": true,
115     "live_moderation_enabled": true,
116     "notice_period": 30,
117     "voice_mixing_allowed": false,
118     "featured": true,
119     "category": "professional",
120     "liked_by_count": 100,
121     "cloned_by_count": 50,
122     "name": "Rachel",
123     "labels": {
124       "accent": "American",
125       "gender": "female"
126     },
127     "review_status": "allowed",
128     "enabled_in_library": true,
129     "history_item_sample_id": "DCwhRBWXzGAHq8TQ4Fs18",
130     "rate": 0.05,
131     "disable_at_unix": 1714204800,
132     "reader_app_enabled": true,
133     "image_url": "image_url",
134     "ban_reason": "ban_reason",
135     "description": "A female voice with a soft and friendly tone.",
136     "review_message": "review_message",
137     "instagram_username": "instagram_username",
138     "twitter_username": "twitter_username",
139     "youtube_username": "youtube_username",
140     "tiktok_username": "tiktok_username",
141     "moderation_check": {
142       "date_checked_unix": 1714204800,
143       "name_value": "Rachel",
144       "name_check": true,
145       "description_value": "A female voice with a soft and friendly tone.",
146       "description_check": true,
147       "sample_ids": [
148         "sample1",
149         "sample2"
150       ],
151       "sample_checks": [
152         0.95,
153         0.98
154       ],
155       "captcha_ids": [
156         "captcha1",
157         "captcha2"
158       ],
159       "captcha_checks": [
160         0.95,
161         0.98
162       ]
163     },
164     "reader_restricted_on": [
165       {
166         "resource_type": "read",
167         "resource_id": "FCwhRBWXzGAHq8TQ4Fs18"
168       }
169     ]
170   },
171   "verified_languages": [
172     {
173       "language": "en",
174       "model_id": "eleven_turbo_v2_5",
175       "accent": "American",
176       "preview_url": "preview_url"
177     }
178   ],
179   "safety_control": "NONE",
180   "voice_verification": {
181     "requires_verification": false,
182     "is_verified": true,
183     "verification_failures": [
184       "verification_failures"
185     ],
186     "verification_attempts_count": 0,
187     "language": "en",
188     "verification_attempts": [
189       {
190         "text": "Hello, how are you?",
191         "date_unix": 1714204800,
192         "accepted": true,
193         "similarity": 0.95,
194         "levenshtein_distance": 2,
195         "recording": {
196           "recording_id": "CwhRBWXzGAHq8TQ4Fs17",
197           "mime_type": "audio/mpeg",
198           "size_bytes": 1000000,
199           "upload_date_unix": 1714204800,
200           "transcription": "Hello, how are you?"
201         }
202       }
203     ]
204   },
205   "permission_on_resource": "permission_on_resource",
206   "is_owner": false,
207   "is_legacy": false,
208   "is_mixed": false,
209   "created_at_unix": 1
210 }

Returns metadata about a specific voice.

Path parameters

voice_idstringRequired

ID of the voice to be used. You can use the Get voices endpoint list all the available voices.

Query parameters

with_settingsbooleanOptionalDefaults to trueDeprecated

This parameter is now deprecated. It is ignored and will be removed in a future version.

Response

Successful Response

voice_idstring

The ID of the voice.

namestring

The name of the voice.

categoryenum

The category of the voice.

labelsmap from strings to strings

Labels associated with the voice.

available_for_tierslist of strings

The tiers the voice is available for.

high_quality_base_model_idslist of strings

The base model IDs for high-quality voices.

sampleslist of objectsOptional

List of samples associated with the voice.

fine_tuningobjectOptional

Fine-tuning information for the voice.

descriptionstringOptional

The description of the voice.

preview_urlstringOptional

The preview URL of the voice.

settingsobjectOptional

The settings of the voice.

verified_languageslist of objectsOptional

The verified languages of the voice.

safety_controlenumOptional

The safety controls of the voice.

voice_verificationobjectOptional

The voice verification of the voice.

permission_on_resourcestringOptional

The permission on the resource of the voice.

is_ownerbooleanOptional

Whether the voice is owned by the user.

is_legacybooleanOptionalDefaults to false

Whether the voice is legacy.

is_mixedbooleanOptionalDefaults to false

Whether the voice is mixed.

created_at_unixintegerOptional

The creation time of the voice in Unix time.

Get voice

Path parameters

Headers

Query parameters

Response

Errors