Core concepts

Webhooks

Get the finished result pushed to your server.

Pass webhook_url (a public HTTPS URL) on POST /api/v1/tts and we POST the final result there. On success:

JSON
{
  "task_id": "...",
  "status": "completed",
  "result": "https://...mp3",
  "srt_url": "https://...srt",
  "characters": 30,
  "created_at": "2026-05-05T12:34:20Z",
  "completed_at": "2026-05-05T12:34:56Z"
}

srt_url is null when no subtitle file could be made. On failure:

JSON
{
  "task_id": "...",
  "status": "failed",
  "error": "Audio generation failed. Please try again.",
  "characters": 30,
  "created_at": "2026-05-05T12:34:20Z"
}

Each webhook is delivered once: a single attempt with a 10-second timeout and no redirects followed. There are no retries, so keep polling GET /api/v1/tts?task_id=... as the fallback.

Search docs

Find a page or an endpoint