Skip to main content
POST
Create audio
The response comes back straight away, usually with status: "pending" and no attachment.url yet. The audio is generated in the background:
  1. Poll: call Get audio with the returned id every few seconds.
  2. Stop polling when status is completed or failed.
  3. Download: once it’s completed, download the file from attachment.url.
Short text is usually ready within a few seconds. The voice and language are checked before anything is created. An invalid pair returns 400 straight away. See Errors.
If the voice’s engine fails, you don’t get an error here. The audio’s status becomes failed instead. Retry, or try another voice.

Authorizations

X-API-KEY
string
header
required

Body

application/json
input
string
required

The text to speak.

Minimum string length: 1
Example:

"أهلاً بيك، إزيك النهارده؟"

languageId
string<uuid>
required
Example:

"2cdab2de-310d-59a3-ad68-b85b4526e37b"

voiceId
string<uuid>
required
Example:

"118d2470-de1d-5093-86b3-f2d8adec3183"

name
string

A label for the audio. Becomes the file name. Defaults to TTS_<timestamp>.

Example:

"greeting"

Response

The new audio, usually with status pending.

message
string
Example:

"Text-to-speech record fetched successfully"

data
object