audivra docs
Start free

Or jump from this list on a smaller screen.

This is a page from the Audivra documentation. Developer exports — index: 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.

Quickstart

Make your first API call in under five minutes.

  1. Create an account

    Sign up at /signup. A default API key is provisioned automatically.

  2. Copy your API key

    Open Keys in the dashboard. Keys use the format sk_live_ followed by 48 hex characters.

  3. Generate speech

    Pick a preset from the voice library — play a sample and copy voice_id.

    cURL
    curl -X POST http://127.0.0.1:3000/api/v1/tts \
  -H "Authorization: Bearer sk_live_…" \
  -H "Content-Type: application/json" \
  -d '{"text":"Hello from Audivra","voice_id":"aurora","model":"kokoro-82m"}' \
  --output speech.wav

  4. Generate a talking avatar (async)

    GPU renders take 2–30 seconds. The API returns a job ID immediately — poll for completion.

    cURL
    curl -X POST http://127.0.0.1:3000/api/v1/generate \
  -H "Authorization: Bearer sk_live_…" \
  -H "Content-Type: application/json" \
  -d '{"text":"Welcome to our launch.","voice_id":"aurora","avatar_id":"studio-host"}'

# Response (202)
# { "job_id": "…", "status": "PROCESSING", "poll": "/api/v1/jobs/…" }

curl http://127.0.0.1:3000/api/v1/jobs/{job_id} \
  -H "Authorization: Bearer sk_live_…"

  5. Lip-sync existing video and audio

    Hosted samples let you test without uploading. Poll until status is completed or failed.

    cURL
    curl -X POST http://127.0.0.1:3000/api/v1/generate \
  -H "Authorization: Bearer sk_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "input": [
      { "type": "video", "url": "http://127.0.0.1:3000/api/docs/samples/example-video.mp4" },
      { "type": "audio", "url": "http://127.0.0.1:3000/api/docs/samples/example-audio.wav" }
    ],
    "options": { "sync_mode": "cut_off" }
  }'

  6. Same credit pool

    Speech, recognition, score beds, cues, talking-heads, and dub share one prepaid wallet. Preview spend with POST /api/v1/estimate, transcribe with STT, queue many jobs with batch generate, or dub via POST /api/v1/dub.

Next: First talking avatar guide · Authentication · SDKs · OpenAPI reference · Developer exports