Create a voice

POST

/v1/text-to-voice

POST

/v1/text-to-voice

1 curl -X POST https://api.elevenlabs.io/v1/text-to-voice \
2      -H "Content-Type: application/json" \
3      -d '{
4   "voice_name": "Sassy squeaky mouse",
5   "voice_description": "A sassy squeaky mouse",
6   "generated_voice_id": "37HceQefKmEi3bGovXjL"
7 }'

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

Create a voice from previously generated voice preview. This endpoint should be called after you fetched a generated_voice_id using POST /v1/text-to-voice/design or POST /v1/text-to-voice/:voice_id/remix.

Headers

xi-api-keystringOptional

Request

This endpoint expects an object.

voice_namestringRequired

Name to use for the created voice.

voice_descriptionstringRequired20-1000 characters

Description to use for the created voice.

generated_voice_idstringRequired

The generated_voice_id to create, call POST /v1/text-to-voice/create-previews and fetch the generated_voice_id from the response header if don’t have one yet.

labelsmap from strings to optional stringsOptional

Optional, metadata to add to the created voice. Defaults to None.

played_not_selected_voice_idslist of stringsOptional

List of voice ids that the user has played but not selected. Used for RLHF.

Response

Successful Response

voice_idstring

The ID of the voice.

namestring

The name of the voice.

sampleslist of objects

List of samples associated with the voice.

categoryenum

The category of the voice.

fine_tuningobject

Fine-tuning information for the voice.

labelsmap from strings to strings

Labels associated with the voice.

descriptionstring

The description of the voice.

preview_urlstring

The preview URL of the voice.

available_for_tierslist of strings

The tiers the voice is available for.

settingsobject

The settings of the voice.

high_quality_base_model_idslist of strings

The base model IDs for high-quality voices.

verified_languageslist of objects

The verified languages of the voice.

collection_idslist of strings

The IDs of collections this voice belongs to.

safety_controlenum

The safety controls of the voice.

Allowed values:

voice_verificationobject

The voice verification of the voice.

permission_on_resourcestring

The permission on the resource of the voice.

is_ownerboolean

Whether the voice is owned by the user.

is_legacybooleanDefaults to false

Whether the voice is legacy.

is_mixedbooleanDefaults to false

Whether the voice is mixed.

favorited_at_unixinteger

Timestamp when the voice was marked as favorite in Unix time.

created_at_unixinteger

The creation time of the voice in Unix time.

is_bookmarkedboolean

Whether the voice is bookmarked by the current user. Only relevant for community (library-copied) voices.

Errors

422

Text to Voice Create Request Unprocessable Entity Error