ENDPOINTSVoicesSettings

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

This endpoint expects an object.
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.
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.
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.
speeddoubleOptional
Adjusts the speed of the voice. A value of 1.0 is the default speed, while values less than 1.0 slow down the speech, and values greater than 1.0 speed it up.

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