Save a voice preview
Add a generated voice to the voice library.
Headers
xi-api-key
Request
This endpoint expects an object.
voice_name
Name to use for the created voice.
voice_description
Description to use for the created voice.
generated_voice_id
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.
labels
Optional, metadata to add to the created voice. Defaults to None.
played_not_selected_voice_ids
List of voice ids that the user has played but not selected. Used for RLHF.
Response
Successful Response
voice_id
The ID of the voice.
name
The name of the voice.
samples
List of samples associated with the voice.
category
The category of the voice.
fine_tuning
Fine-tuning information for the voice.
labels
Labels associated with the voice.
description
The description of the voice.
preview_url
The preview URL of the voice.
available_for_tiers
The tiers the voice is available for.
settings
The settings of the voice.
sharing
The sharing information of the voice.
high_quality_base_model_ids
The base model IDs for high-quality voices.
verified_languages
The verified languages of the voice.
safety_control
The safety controls of the voice.
voice_verification
The voice verification of the voice.
permission_on_resource
The permission on the resource of the voice.
is_owner
Whether the voice is owned by the user.
is_legacy
Whether the voice is legacy.
is_mixed
Whether the voice is mixed.
created_at_unix
The creation time of the voice in Unix time.