Save a voice 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/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 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.

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.

sharingobjectOptional

The sharing information 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.

Errors

Built with