Or jump from this list on a smaller screen.

This is a page from the Audivra documentation. Developer exportsindex: http://127.0.0.1:3000/docs/llms.txt, full corpus: http://127.0.0.1:3000/docs/llms-full.txt, OpenAPI: http://127.0.0.1:3000/docs/openapi.json, Postman: http://127.0.0.1:3000/docs/postman.json. Press ⌘K to search docs.

Avatars & jobs

Create lip-synced talking-head videos asynchronously — poll status or subscribe to SSE events.

POST
/api/v1/avatar
Auth required

Dashboard-friendly avatar job — returns 202 + job_id with SSE pipeline updates.

Request body

JSON
{
  "text": "Welcome to our product launch.",
  "voice_id": "aurora",
  "avatar_id": "studio-host",
  "video_model": "musetalk"
}

Response

JSON
{
  "job_id": "…",
  "status": "queued",
  "events": "/api/v1/jobs/{id}/events"
}
GET
/api/v1/jobs/{id}
Auth required

Poll job status, duration, and output URL when completed.

GET
/api/v1/jobs/{id}/events
Auth required

Server-sent events for live pipeline progress (tts → lipsync → render).

GET
/api/v1/avatar/{id}/video
Auth required

Download completed MP4 when job status is completed.

GET
/api/v1/avatars

List avatar presets and supported video models.

Poll until complete
JOB=$(curl -s -X POST http://127.0.0.1:3000/api/v1/generate \
  -H "Authorization: Bearer sk_live_…" \
  -H "Content-Type: application/json" \
  -d '{"text":"Hello","voice_id":"aurora","avatar_id":"studio-host"}' | jq -r .job_id)

curl http://127.0.0.1:3000/api/v1/jobs/$JOB -H "Authorization: Bearer sk_live_…"

Avatar presets: Avatars reference · Try generate in browser

Step-by-step guide: First talking avatar in 5 minutes