ENDPOINTSVoices

Edit voice settings

Edit your settings for a specific voice. “similarity_boost” corresponds to “Clarity + Similarity Enhancement” in the web app and “stability” corresponds to “Stability” slider in the web app.

Path parameters

voice_idstringRequired

ID of the voice to be used. You can use the Get voices endpoint list all the available voices.

Headers

xi-api-keystringRequired

Request

The settings for a specific voice.

stabilitydoubleOptional

Determines how stable the voice is and the randomness between each generation. Lower values introduce broader emotional range for the voice. Higher values can result in a monotonous voice with limited emotion.

similarity_boostdoubleOptional

Determines how closely the AI should adhere to the original voice when attempting to replicate it.

styledoubleOptional

Determines the style exaggeration of the voice. This setting attempts to amplify the style of the original speaker. It does consume additional computational resources and might increase latency if set to anything other than 0.

use_speaker_boostbooleanOptional

This setting boosts the similarity to the original speaker. Using this setting requires a slightly higher computational load, which in turn increases latency.

speeddoubleOptional

Controls the speed of the generated speech. Values range from 0.7 to 1.2, with 1.0 being the default speed. Lower values create slower, more deliberate speech while higher values produce faster-paced speech. Extreme values can impact the quality of the generated speech.

Response

Successful Response

statusstring

The status of the voice settings edit request. If the request was successful, the status will be ‘ok’. Otherwise an error message with status 500 will be returned.

Errors