BEbeyondwords
Voices

Finalize voice design

Changed on

Create a permanent voice from a generated design preview

post/organization/voices/finalize_design

Request

  • Base URL
    https://api.beyondwords.io/v1
  • URL
    https://api.beyondwords.io/v1/organization/voices/finalize_design
  • Auth
    API key in header X-Api-Key

Request body

generated_voice_idstring required

The generated voice ID returned by the design_previews endpoint

namestring required

Name for the new voice

descriptionstring required

Optional description of the voice

gender'male' | 'female' | 'neutral'

Gender of the voice

Response

Created

idinteger

Unique identifier for the object

namestring

The name of the voice

type'premade' | 'instant' | 'professional' | 'generated'

The type of the voice

status'draft' | 'recording' | 'processing' | 'review' | 'enabled' | 'deprecated' | 'disabled' | 'unavailable'

The status of the voice

preview_statuses'processing' | 'processed'

The preview status of the voice for its primary language

script_idsinteger[]

The script IDs associated with the voice

speaking_rateinteger

The speaking rate of the voice

multilingual_modeboolean
expressivenessnumber nullable
use_speaker_boostboolean nullable
similarity_boostnumber nullable
stylenumber nullable
clone_strengthnumber nullable

Only applied to ElevenLabs professional voice clones on eleven_v4 / eleven_v4_turbo

cloning_consentstring nullable

The cloning consent URL for instant and professional voices

clone_errorsobject[]

An array of voice cloning errors in the standard error format

createdstring date-time

Time at which the object was created (ISO 8601)

updatedstring date-time

Time at which the object was updated (ISO 8601)

logo_patterninteger nullable

Logo pattern number

logo_color'red' | 'green' | 'blue' | 'purple' | 'gray' | 'pink' | 'cyan' nullable

Logo pattern color

gender'male' | 'female' | 'neutral' nullable

The gender of the voice

languagestring

The language of the voice

secondary_languagesstring[]

The secondary languages of the voice

servicestring

The source of the voice

model_idstring nullable
expected_model_idsstring[] nullable

Model IDs the voice will be available for once cloning finishes. Only present while the voice is recording or processing

preview_urlstring nullable

The preview URL of the voice

premiumboolean

Whether the voice is premium or not

exclusiveboolean

Whether the voice is exclusive or not

customboolean

The custom flag of the voice

additionalboolean
pauses_supportedboolean
clone_strength_supportedboolean

Whether the clone_strength voice setting is applied for this voice

Changes

  • 994b9853e685Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status