Save Voice from Preview

POST

/v1/text-to-voice/create-voice-from-preview

Add a generated voice to the voice library.

Request

This endpoint expects an object.

voice_namestringRequired

Name to use for the created voice.

voice_descriptionstringRequired>=20 characters<=1000 characters

Description to use for the created voice.

generated_voice_idstringRequired

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

labelsmap from strings to 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

namestringOptional

sampleslist of objectsOptional

categoryenumOptional

fine_tuningobjectOptional

labelsmap from strings to stringsOptional

descriptionstringOptional

preview_urlstringOptional

available_for_tierslist of stringsOptional

settingsobjectOptional

high_quality_base_model_idslist of stringsOptional

safety_controlenumOptional

voice_verificationobjectOptional

permission_on_resourcestringOptional

is_ownerbooleanOptional

is_legacybooleanOptional

is_mixedbooleanOptional

created_at_unixintegerOptional

POST

1 curl -X POST https://api.elevenlabs.io/v1/text-to-voice/create-voice-from-preview \
2      -H "xi-api-key: <apiKey>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "voice_name": "Little squeaky mouse",
6   "voice_description": "A sassy little squeaky mouse",
7   "generated_voice_id": "37HceQefKmEi3bGovXjL"
8 }'

200Successful

1 {
2   "voice_id": "voice_id",
3   "name": "name",
4   "samples": [
5     {
6       "sample_id": "sample_id",
7       "file_name": "file_name",
8       "mime_type": "mime_type",
9       "size_bytes": 1,
10       "hash": "hash"
11     }
12   ],
13   "category": "generated",
14   "fine_tuning": {
15     "is_allowed_to_fine_tune": true,
16     "state": {
17       "key": "not_started"
18     },
19     "verification_failures": [
20       "verification_failures"
21     ],
22     "verification_attempts_count": 1,
23     "manual_verification_requested": true,
24     "language": "language",
25     "progress": {
26       "key": 1.1
27     },
28     "message": {
29       "key": "value"
30     },
31     "dataset_duration_seconds": 1.1,
32     "verification_attempts": [
33       {
34         "text": "text",
35         "date_unix": 1,
36         "accepted": true,
37         "similarity": 1.1,
38         "levenshtein_distance": 1.1
39       }
40     ],
41     "slice_ids": [
42       "slice_ids"
43     ],
44     "manual_verification": {
45       "extra_text": "extra_text",
46       "request_time_unix": 1,
47       "files": [
48         {
49           "file_id": "file_id",
50           "file_name": "file_name",
51           "mime_type": "mime_type",
52           "size_bytes": 1,
53           "upload_date_unix": 1
54         }
55       ]
56     },
57     "max_verification_attempts": 1,
58     "next_max_verification_attempts_reset_unix_ms": 1,
59     "finetuning_state": {
60       "key": "value"
61     }
62   },
63   "labels": {
64     "key": "value"
65   },
66   "description": "description",
67   "preview_url": "preview_url",
68   "available_for_tiers": [
69     "available_for_tiers"
70   ],
71   "settings": {
72     "stability": 1.1,
73     "similarity_boost": 1.1,
74     "style": 1.1,
75     "use_speaker_boost": true
76   },
77   "sharing": {
78     "status": "enabled",
79     "history_item_sample_id": "history_item_sample_id",
80     "date_unix": 1,
81     "whitelisted_emails": [
82       "whitelisted_emails"
83     ],
84     "public_owner_id": "public_owner_id",
85     "original_voice_id": "original_voice_id",
86     "financial_rewards_enabled": true,
87     "free_users_allowed": true,
88     "live_moderation_enabled": true,
89     "rate": 1.1,
90     "notice_period": 1,
91     "disable_at_unix": 1,
92     "voice_mixing_allowed": true,
93     "featured": true,
94     "category": "generated",
95     "reader_app_enabled": true,
96     "image_url": "image_url",
97     "ban_reason": "ban_reason",
98     "liked_by_count": 1,
99     "cloned_by_count": 1,
100     "name": "name",
101     "description": "description",
102     "labels": {
103       "key": "value"
104     },
105     "review_status": "not_requested",
106     "review_message": "review_message",
107     "enabled_in_library": true,
108     "instagram_username": "instagram_username",
109     "twitter_username": "twitter_username",
110     "youtube_username": "youtube_username",
111     "tiktok_username": "tiktok_username",
112     "moderation_check": {
113       "date_checked_unix": 1,
114       "name_value": "name_value",
115       "name_check": true,
116       "description_value": "description_value",
117       "description_check": true,
118       "sample_ids": [
119         "sample_ids"
120       ],
121       "sample_checks": [
122         1.1
123       ],
124       "captcha_ids": [
125         "captcha_ids"
126       ],
127       "captcha_checks": [
128         1.1
129       ]
130     },
131     "reader_restricted_on": [
132       {
133         "resource_type": "read",
134         "resource_id": "resource_id"
135       }
136     ]
137   },
138   "high_quality_base_model_ids": [
139     "high_quality_base_model_ids"
140   ],
141   "safety_control": "NONE",
142   "voice_verification": {
143     "requires_verification": true,
144     "is_verified": true,
145     "verification_failures": [
146       "verification_failures"
147     ],
148     "verification_attempts_count": 1,
149     "language": "language",
150     "verification_attempts": [
151       {
152         "text": "text",
153         "date_unix": 1,
154         "accepted": true,
155         "similarity": 1.1,
156         "levenshtein_distance": 1.1
157       }
158     ]
159   },
160   "permission_on_resource": "permission_on_resource",
161   "is_owner": true,
162   "is_legacy": true,
163   "is_mixed": true,
164   "created_at_unix": 1
165 }

Dub a Video or Audio File

Up Next

Built with

1	curl -X POST https://api.elevenlabs.io/v1/text-to-voice/create-voice-from-preview \
2	-H "xi-api-key: <apiKey>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"voice_name": "Little squeaky mouse",
6	"voice_description": "A sassy little squeaky mouse",
7	"generated_voice_id": "37HceQefKmEi3bGovXjL"
8	}'

1	{
2	"voice_id": "voice_id",
3	"name": "name",
4	"samples": [
5	{
6	"sample_id": "sample_id",
7	"file_name": "file_name",
8	"mime_type": "mime_type",
9	"size_bytes": 1,
10	"hash": "hash"
11	}
12	],
13	"category": "generated",
14	"fine_tuning": {
15	"is_allowed_to_fine_tune": true,
16	"state": {
17	"key": "not_started"
18	},
19	"verification_failures": [
20	"verification_failures"
21	],
22	"verification_attempts_count": 1,
23	"manual_verification_requested": true,
24	"language": "language",
25	"progress": {
26	"key": 1.1
27	},
28	"message": {
29	"key": "value"
30	},
31	"dataset_duration_seconds": 1.1,
32	"verification_attempts": [
33	{
34	"text": "text",
35	"date_unix": 1,
36	"accepted": true,
37	"similarity": 1.1,
38	"levenshtein_distance": 1.1
39	}
40	],
41	"slice_ids": [
42	"slice_ids"
43	],
44	"manual_verification": {
45	"extra_text": "extra_text",
46	"request_time_unix": 1,
47	"files": [
48	{
49	"file_id": "file_id",
50	"file_name": "file_name",
51	"mime_type": "mime_type",
52	"size_bytes": 1,
53	"upload_date_unix": 1
54	}
55	]
56	},
57	"max_verification_attempts": 1,
58	"next_max_verification_attempts_reset_unix_ms": 1,
59	"finetuning_state": {
60	"key": "value"
61	}
62	},
63	"labels": {
64	"key": "value"
65	},
66	"description": "description",
67	"preview_url": "preview_url",
68	"available_for_tiers": [
69	"available_for_tiers"
70	],
71	"settings": {
72	"stability": 1.1,
73	"similarity_boost": 1.1,
74	"style": 1.1,
75	"use_speaker_boost": true
76	},
77	"sharing": {
78	"status": "enabled",
79	"history_item_sample_id": "history_item_sample_id",
80	"date_unix": 1,
81	"whitelisted_emails": [
82	"whitelisted_emails"
83	],
84	"public_owner_id": "public_owner_id",
85	"original_voice_id": "original_voice_id",
86	"financial_rewards_enabled": true,
87	"free_users_allowed": true,
88	"live_moderation_enabled": true,
89	"rate": 1.1,
90	"notice_period": 1,
91	"disable_at_unix": 1,
92	"voice_mixing_allowed": true,
93	"featured": true,
94	"category": "generated",
95	"reader_app_enabled": true,
96	"image_url": "image_url",
97	"ban_reason": "ban_reason",
98	"liked_by_count": 1,
99	"cloned_by_count": 1,
100	"name": "name",
101	"description": "description",
102	"labels": {
103	"key": "value"
104	},
105	"review_status": "not_requested",
106	"review_message": "review_message",
107	"enabled_in_library": true,
108	"instagram_username": "instagram_username",
109	"twitter_username": "twitter_username",
110	"youtube_username": "youtube_username",
111	"tiktok_username": "tiktok_username",
112	"moderation_check": {
113	"date_checked_unix": 1,
114	"name_value": "name_value",
115	"name_check": true,
116	"description_value": "description_value",
117	"description_check": true,
118	"sample_ids": [
119	"sample_ids"
120	],
121	"sample_checks": [
122	1.1
123	],
124	"captcha_ids": [
125	"captcha_ids"
126	],
127	"captcha_checks": [
128	1.1
129	]
130	},
131	"reader_restricted_on": [
132	{
133	"resource_type": "read",
134	"resource_id": "resource_id"
135	}
136	]
137	},
138	"high_quality_base_model_ids": [
139	"high_quality_base_model_ids"
140	],
141	"safety_control": "NONE",
142	"voice_verification": {
143	"requires_verification": true,
144	"is_verified": true,
145	"verification_failures": [
146	"verification_failures"
147	],
148	"verification_attempts_count": 1,
149	"language": "language",
150	"verification_attempts": [
151	{
152	"text": "text",
153	"date_unix": 1,
154	"accepted": true,
155	"similarity": 1.1,
156	"levenshtein_distance": 1.1
157	}
158	]
159	},
160	"permission_on_resource": "permission_on_resource",
161	"is_owner": true,
162	"is_legacy": true,
163	"is_mixed": true,
164	"created_at_unix": 1
165	}