Audio

Convert text to speech using a named built-in preset voice, with optional language and either an emotion or a delivery note, depending on the voice. Both text and voice_preset_id are required and the text is limited to 250 characters. The voices named by a first name (e.g. "Rachel") take a delivery note (at most 50 characters, e.g. "angry, shouting") and no emotion; the descriptive voices (e.g. "Serious woman") take an emotion and no delivery note. Invalid input, including an emotion or delivery note the voice does not take, returns HTTP 400. The job result is a single audio result containing the URL of an MP3 or WAV file (the URL's extension, .mp3 or .wav, says which). Credits are held when the job is accepted and refunded if it fails or is cancelled. Use this when you want a ready-made catalog voice and do not need to supply your own sample; use createSpeech to clone a voice from an audio sample instead, and createVoice to design a new voice from a text description. Pass an optional request_id to tag the result so you can locate it later via listGenerations (type audio). Requires an API key (user scope). The call returns 202 with a job id - poll getApiJob (pass wait 30 to long-poll) honouring poll_after_ms, until status is succeeded; its result field is exactly the response documented for this operation. Synchronous responses are deprecated but still supported: pass `async: false` to block until the result is ready and receive it as the response body. Synchronous calls run on the same queue: the response carries an X-Ludo-Job-Id header, and a job still running after 15 minutes comes back as 202 with the job instead of an error. Each account may have up to 50 generations queued or running at once via the API; a request beyond that returns 429 (code PENDING_JOBS_LIMIT).

Changed on
post/audio/speech-preset

Request

  • Base URL
    https://api.ludo.ai/api
  • Auth
    API key in header Authorization

Request body

textstring required

Text to convert to speech (max 250 characters).

voice_preset_idstring required

Voice preset identifier. Two families of voices: the ones named by a first name (e.g. "Rachel", "Roger") take a delivery note and no emotion; the descriptive ones (e.g. "Serious woman", "Deep voice man") take an emotion and no delivery note.

emotionstring

Emotion to apply to the speech. Only for the descriptive voices (e.g. "Serious woman"); a first-name voice returns HTTP 400 for any emotion other than Default - use delivery instead.

deliverystring

How the line is said, e.g. "angry, shouting" or "whispering, out of breath" (max 50 characters). Only for the first-name voices (e.g. "Rachel"); a descriptive voice returns HTTP 400 - use emotion instead.

languagestring

Language of the speech. Each voice family supports its own list of languages; "auto" detects it from the text.

request_idstring

Optional client-provided identifier, unique per request. Re-sending the same request_id returns the existing job instead of generating again. Also usable as the request_id filter of listGenerations.

asyncboolean

Defaults to true: the call returns 202 immediately with a job id to poll with getApiJob. Set false for a synchronous response (deprecated but supported): the call then blocks until the result is ready.

Response

Success

urlstring

URL of the generated audio file: MP3 or WAV; the extension (.mp3 or .wav) says which.

typestring
durationnumber float
request_idstring
created_atinteger

Changes