Skip to main content

PreviewVoiceRequest

Request to synthesize a short preview of a cloned voice. text defaults to a canned line when omitted; the voice settings are optional and default to balanced values. selected_voice_id identifies which voice to preview on endpoints where the voice is not a path variable (e.g. the campaign-offer preview); endpoints that carry the voice id in the path ignore it.

textstringnullable

Text to synthesize for the preview. Defaults to a canned line when omitted.

Example: Hello, this is a preview of my podcast voice.
stabilitydoublenullable

Voice stability, from 0.0 (more variable) to 1.0 (more consistent).

Example: 0.5
similarity_boostdoublenullable

Similarity boost, from 0.0 to 1.0, controlling how closely the output matches the original voice.

Example: 0.75
styledoublenullable

Style exaggeration, from 0.0 to 1.0.

Example: 0
use_speaker_boostbooleannullable

Whether to boost the resemblance to the speaker.

Example: true
speeddoublenullable

Playback speed multiplier for the synthesized audio.

Example: 1
selected_voice_idstringnullable

Identifier of the voice to preview, on endpoints where the voice is not a path variable. Ignored when the voice id is in the path.

Example: 7Hb2Kp9QvL3mNx0R8tZ4
PreviewVoiceRequest
{
"text": "Hello, this is a preview of my podcast voice.",
"stability": 0.5,
"similarity_boost": 0.75,
"style": 0,
"use_speaker_boost": true,
"speed": 1,
"selected_voice_id": "7Hb2Kp9QvL3mNx0R8tZ4"
}