ENDPOINTSText to Voice

Voice design

Create a voice from a text prompt.

Headers

xi-api-keystringRequired

Query parameters

output_formatenumOptionalDefaults to mp3_44100_192
The output format of the generated audio.

Request

This endpoint expects an object.
voice_descriptionstringRequired>=20 characters<=1000 characters
Description to use for the created voice.
textstringOptional>=100 characters<=1000 characters
Text to generate, text length has to be between 100 and 1000.
auto_generate_textbooleanOptionalDefaults to false
Whether to automatically generate a text suitable for the voice description.
loudnessdoubleOptional>=-1<=1Defaults to 0.5

Controls the volume level of the generated voice. -1 is quietest, 1 is loudest, 0 corresponds to roughly -24 LUFS.

qualitydoubleOptional>=-1<=1Defaults to 0.9
Higher quality results in better voice output but less variety.
seedintegerOptional>=0<=2147483647
Random number that controls the voice generation. Same seed with same inputs produces same voice.
guidance_scaledoubleOptional>=0<=100Defaults to 5
Controls how closely the AI follows the prompt. Lower numbers give the AI more freedom to be creative, while higher numbers force it to stick more to the prompt. High numbers can cause voice to sound artificial or robotic. We recommend to use longer, more detailed prompts at lower Guidance Scale.

Response

Successful Response
previewslist of objects
The previews of the generated voices.
textstring
The text used to preview the voices.

Errors