TextToSpeech

Synthesize speech (async)

Submit a synthesis job that runs in the background and immediately receive a [long-running operation](https://google.aip.dev/151). Poll the operation via the Get operation endpoint until `done` is `true`, then download the results from the time-limited signed URLs in its `response`. The request body is identical to synchronous synthesis. Unlike the synchronous endpoints, a job never returns audio with requested timestamps silently missing: `timestampType` in a language without alignment support is rejected at submit, and an alignment failure during synthesis fails the operation.

POST/tts/v1/voice:synthesizeAsync

Authorizations

Authorizationstringrequired

Your authentication credentials. For Basic authentication, please populate Basic $INWORLD_API_KEY. You can create a key in one command with the Inworld CLI: inworld workspace add-key.

Body

application/json

textstringrequired

The text to be synthesized into speech. Maximum input of 100,000 characters. On-Demand accounts are capped at 10,000 characters per job.

Synthesize speech (async)

curl --location 'https://api.inworld.ai/tts/v1/voice:synthesizeAsync' \
--header "Authorization: Basic $INWORLD_API_KEY" \
--header 'Content-Type: application/json' \
--data '{
  "text": "Hello, world! What a wonderful day to be a text-to-speech model!",
  "voiceId": "Dennis",
  "modelId": "inworld-tts-2",
  "audioConfig": {
    "audioEncoding": "MP3"
  },
  "timestampType": "WORD"
}'

submitted

{
  "name": "workspaces/{workspace}/ttsAsyncJobs/8f14e45f-ceea-4673-93d8-04f724c8a1b2/operations/1784837936461-p0sEhU",
  "metadata": null,
  "done": false
}