latestSwagger 2.02026-08-19218237253.7 KB

3af866d68651

Audio

Design a new voice from a character description (such as "deep-voiced warrior" or "cheerful young girl") and have it speak a short line of text, returning a sample of that newly created voice. Both voice_description and text are required, the spoken text is limited to 200 characters or the call returns HTTP 400, and type selects "human" or "non-human" voices. Synchronous: the call blocks until generation finishes and returns a single audio result containing a URL; there is no separate polling step. Credits are charged on success. Use this to invent and audition a voice from a description; use createSpeech for text-to-speech that clones a specific voice from an audio sample, and createSpeechPreset for text-to-speech using a named preset voice. Pass an optional request_id to tag the result so you can locate it later via getAudioResults. Requires an API key (user scope).

post/audio/voice

Request body

voice_descriptionstring required

Text description of the voice character (e.g., "deep-voiced warrior", "cheerful young girl").

textstring required

Text for the voice to speak (max 20 words).

type'human' | 'non-human'

Type of voice to generate.

augment_promptboolean

Augment the prompt behind the scenes. Disable to have more control.

request_idstring

Optional client-provided identifier for this request. Use this to retrieve results later via the results endpoint.

Response

Success

urlstring

URL to the generated audio file

typestring
durationnumber float
request_idstring
created_atinteger