Save Voice from Preview

Add a generated voice to the voice library.

Headers

xi-api-key

string

Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

Body

application/json

voice_name

string

required

Name to use for the created voice.

voice_description

string

required

Description to use for the created voice.

Required string length: 20 - 1000

generated_voice_id

string

required

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.

labels

object

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

Show child attributes

labels.{key}

string

played_not_selected_voice_ids

string[]

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

Response

200 - application/json

voice_id

string

required

name

string

required

samples

object[]

required

Show child attributes

samples.sample_id

string

required

samples.file_name

string

required

samples.mime_type

string

required

samples.size_bytes

integer

required

samples.hash

string

required

category

enum<string>

required

Available options:

generated,

cloned,

premade,

professional,

famous,

high_quality

fine_tuning

object

required

Show child attributes

fine_tuning.is_allowed_to_fine_tune

boolean

required

fine_tuning.state

object

required

Show child attributes

fine_tuning.state.{key}

enum<string>

Available options:

not_started,

queued,

fine_tuning,

fine_tuned,

failed,

delayed

fine_tuning.verification_failures

string[]

required

fine_tuning.verification_attempts_count

integer

required

fine_tuning.manual_verification_requested

boolean

required

fine_tuning.language

string

fine_tuning.progress

object

Show child attributes

fine_tuning.progress.{key}

number

fine_tuning.message

object

Show child attributes

fine_tuning.message.{key}

string

fine_tuning.dataset_duration_seconds

number

fine_tuning.verification_attempts

object[]

Show child attributes

fine_tuning.verification_attempts.text

string

required

fine_tuning.verification_attempts.date_unix

integer

required

fine_tuning.verification_attempts.accepted

boolean

required

fine_tuning.verification_attempts.similarity

number

required

fine_tuning.verification_attempts.levenshtein_distance

number

required

fine_tuning.verification_attempts.recording

object

Show child attributes

fine_tuning.verification_attempts.recording.recording_id

string

required

fine_tuning.verification_attempts.recording.mime_type

string

required

fine_tuning.verification_attempts.recording.size_bytes

integer

required

fine_tuning.verification_attempts.recording.upload_date_unix

integer

required

fine_tuning.verification_attempts.recording.transcription

string

required

fine_tuning.slice_ids

string[]

fine_tuning.manual_verification

object

Show child attributes

fine_tuning.manual_verification.extra_text

string

required

fine_tuning.manual_verification.request_time_unix

integer

required

fine_tuning.manual_verification.files

object[]

required

Show child attributes

fine_tuning.manual_verification.files.file_id

string

required

fine_tuning.manual_verification.files.file_name

string

required

fine_tuning.manual_verification.files.mime_type

string

required

fine_tuning.manual_verification.files.size_bytes

integer

required

fine_tuning.manual_verification.files.upload_date_unix

integer

required

fine_tuning.max_verification_attempts

integer

fine_tuning.next_max_verification_attempts_reset_unix_ms

integer

labels

object

required

Show child attributes

labels.{key}

string

description

string

required

preview_url

string

required

available_for_tiers

string[]

required

settings

object

required

Show child attributes

settings.stability

number

required

settings.similarity_boost

number

required

settings.style

number

default: 0

settings.use_speaker_boost

boolean

default: true

sharing

object

required

Show child attributes

sharing.status

enum<string>

required

Available options:

enabled,

disabled,

copied,

copied_disabled

sharing.history_item_sample_id

string

required

sharing.date_unix

integer

required

sharing.whitelisted_emails

string[]

required

sharing.public_owner_id

string

required

sharing.original_voice_id

string

required

sharing.financial_rewards_enabled

boolean

required

sharing.free_users_allowed

boolean

required

sharing.live_moderation_enabled

boolean

required

sharing.rate

number

required

sharing.notice_period

integer

required

sharing.disable_at_unix

integer

required

sharing.voice_mixing_allowed

boolean

required

sharing.featured

boolean

required

sharing.category

enum<string>

required

Available options:

generated,

professional,

high_quality,

famous

sharing.reader_app_enabled

boolean

required

sharing.image_url

string

required

sharing.ban_reason

string

required

sharing.liked_by_count

integer

required

sharing.cloned_by_count

integer

required

sharing.name

string

required

sharing.description

string

required

sharing.labels

object

required

Show child attributes

sharing.labels.{key}

string

sharing.review_status

enum<string>

required

Available options:

not_requested,

pending,

declined,

allowed,

allowed_with_changes

sharing.review_message

string

required

sharing.enabled_in_library

boolean

required

sharing.instagram_username

string

sharing.twitter_username

string

sharing.youtube_username

string

sharing.tiktok_username

string

sharing.moderation_check

object

Show child attributes

sharing.moderation_check.date_checked_unix

integer

sharing.moderation_check.name_value

string

sharing.moderation_check.name_check

boolean

sharing.moderation_check.description_value

string

sharing.moderation_check.description_check

boolean

sharing.moderation_check.sample_ids

string[]

sharing.moderation_check.sample_checks

number[]

sharing.moderation_check.captcha_ids

string[]

sharing.moderation_check.captcha_checks

number[]

sharing.reader_restricted_on

object[]

Show child attributes

sharing.reader_restricted_on.resource_type

enum<string>

required

Available options:

read,

collection

sharing.reader_restricted_on.resource_id

string

required

high_quality_base_model_ids

string[]

required

safety_control

enum<string>

Available options:

NONE,

BAN,

CAPTCHA,

CAPTCHA_AND_MODERATION,

ENTERPRISE_BAN,

ENTERPRISE_CAPTCHA

voice_verification

object

Show child attributes

voice_verification.requires_verification

boolean

required

voice_verification.is_verified

boolean

required

voice_verification.verification_failures

string[]

required

voice_verification.verification_attempts_count

integer

required

voice_verification.language

string

voice_verification.verification_attempts

object[]

Show child attributes

voice_verification.verification_attempts.text

string

required

voice_verification.verification_attempts.date_unix

integer

required

voice_verification.verification_attempts.accepted

boolean

required

voice_verification.verification_attempts.similarity

number

required

voice_verification.verification_attempts.levenshtein_distance

number

required

voice_verification.verification_attempts.recording

object

Show child attributes

voice_verification.verification_attempts.recording.recording_id

string

required

voice_verification.verification_attempts.recording.mime_type

string

required

voice_verification.verification_attempts.recording.size_bytes

integer

required

voice_verification.verification_attempts.recording.upload_date_unix

integer

required

voice_verification.verification_attempts.recording.transcription

string

required

permission_on_resource

string

is_owner

boolean

is_legacy

boolean

default: false

is_mixed

boolean

default: false

created_at_unix

integer