# Mirage Avatar X API

> Avatar X-video met pratend hoofd, aangestuurd door je audio en een afbeelding-, video- of stockavatarreferentie

Maakt een lipsynchroon avatarvideo vanuit `audio_url` (3 tot 180 seconden). De beelden komen uit `video_reference_url`, `image_reference_url` of een stock-`avatar`; de videoreferentie heeft voorrang op de afbeelding wanneer beide zijn opgegeven. De avataroptie levert alleen beelden, geen audio. Referentie-URL's moeten publiek toegankelijk zijn via HTTPS.

- Model id: `mirage-api/avatar-x/reference-to-video`
- Made by: Mirage
- Category: Lipsync & Avatars
- Output: video
- Price per second of your input audio: $0.30 / second of input audio (cheapest run $0.30 (300 API credits))
- Run: `POST https://api.doitong.com/v1/run/mirage-api/avatar-x/reference-to-video`
- Quote: `POST https://api.doitong.com/v1/quote/mirage-api/avatar-x/reference-to-video`
- Docs page: https://doitong.com/nl/developers/models/mirage-api/avatar-x/reference-to-video

## Pricing

Price: **$0.30 / second of input audio**. Price per second of your input audio: the input files are measured before the run (length, resolution, frame rate). The quote measures the same files and is exactly what the run charges.

The full example input below costs $3.00 = 3000 API credits (10 s input audio × $0.30).

Prices are the upstream price in USD, paid from the API balance in API credits (1000 API credits = 1 USD). `POST https://api.doitong.com/v1/quote/mirage-api/avatar-x/reference-to-video` with the same JSON body returns the exact price for that input; the quote is exactly what a run charges. Invalid input is never charged and failed or canceled requests are refunded automatically.

## Input parameters

Send either the canonical name or the native field name (not both). Canonical names are the same across models.

| Parameter | Canonical name | Type | Required | Default | Allowed values / range | Description |
|---|---|---|---|---|---|---|
| `audio_url` | `audio` | string (audio URL) | yes |  |  | Openbaar HTTPS-adres voor de audio die de gegenereerde video aanstuurt, toegankelijk zonder autorisatieheaders of cookies. Geaccepteerde audioformaten zijn FLAC, Opus of Vorbis, AAC of ALAC, PCM WAV of AIFF en MP3. Het bestand moet één mono- of stereostream bevatten, 3–180 seconden duren, maximaal 64 MiB groot zijn en een samplefrequentie van 8–48 kHz hebben. |
| `video_reference_url` |  | string \| null | no |  |  | Openbare HTTPS-URL van de referentievideo, zonder autorisatieheaders of cookies, naar een bestand met precies één videostream en ten minste één geschikte segment van 1 seconde als referentie; audio wordt genegeerd. Geaccepteerd zijn .mp4, .mov of .m4v met H.264, H.265/HEVC of ProRes, of .webm met VP8 of VP9; de duur moet 1 tot 120 seconden zijn, de grootte maximaal 1 GiB en de beeldverhouding binnen 5% van 9:16 of 16:9 vallen. Als image_reference_url ook is opgegeven, heeft de video voorrang. |
| `avatar` |  | enum (string) \| null | no |  | `None`, `Ayesha`, `Ayesha (16:9)`, `Farhan`, `Farhan (16:9)`, `Giulia`, `Giulia (16:9)`, `Jasmine`, `Jasmine (16:9)`, `Luke`, `Luke (16:9)`, `Maya`, `Maya (16:9)`, `Michael`, `Michael (16:9)`, `Neha`, `Neha (16:9)`, `Tariq`, `Tariq (16:9)`, `Valerie`, `Valerie (16:9)` | Selectie van stockbeelden, alleen gebruikt wanneer geen afbeelding- of videoreferentie wordt opgegeven; None en de standaardwaarde laten dit niet ingesteld. Deze visual levert nooit audio; die komt altijd van audio_url. Bekijk de opties in de [avatarcatalogus](https://captions.ai/help/docs/api/actor-catalog) en kopieer de exacte Avatar-waarde om een visual te kiezen. |
| `image_reference_url` |  | string \| null | no |  |  | HTTPS-URL van een referentieafbeelding, openbaar toegankelijk zonder cookies of autorisatieheaders; door video_reference_url op te geven wordt deze genegeerd. Accepteert één statische afbeelding in .jpg-, .jpeg-, .png- of .webp-formaat, maximaal 25 MiB en 25 megapixel. De kortste zijde moet minstens 512 px zijn en geen zijde mag groter zijn dan 8192 px; de beeldverhouding moet binnen 5% van 9:16 of 16:9 vallen. |

File parameters (`audio`) take a public `https://` URL, a `data:` URI up to 10 MB, or the `file_url` of an upload from `POST /files`.

## Example input

Required parameters only:

```json
{
  "audio": "https://content.doitong.com/audio/showcase/v3/tools/dub_es.mp3"
}
```

A fuller example:

```json
{
  "audio_url": "https://content.doitong.com/audio/showcase/v3/tools/dub_es.mp3"
}
```

## Run it

Set `DOITONG_API_KEY` to a key from https://doitong.com/developers/dashboard#keys. `?wait=20` returns the finished request in the same call when it is ready within 20 seconds; otherwise poll `GET /requests/{id}` (it also accepts `?wait=`), or pass `webhook_url`.

### curl

```bash
# Run the model; wait up to 20 s for the finished result in the same call
curl -X POST "https://api.doitong.com/v1/run/mirage-api/avatar-x/reference-to-video?wait=20" \
  -H "Authorization: Bearer $DOITONG_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "audio_url": "https://content.doitong.com/audio/showcase/v3/tools/dub_es.mp3"
  }'

# Still "queued" or "running"? Poll with the id from the response:
curl "https://api.doitong.com/v1/requests/REQUEST_ID?wait=20" \
  -H "Authorization: Bearer $DOITONG_API_KEY"
```

### JavaScript

```javascript
const API = "https://api.doitong.com/v1";
const headers = {
  "Authorization": "Bearer " + process.env.DOITONG_API_KEY,
  "Content-Type": "application/json",
};

// Run the model; wait up to 20 s for the finished result in the same call
let res = await fetch(API + "/run/mirage-api/avatar-x/reference-to-video?wait=20", {
  method: "POST",
  headers,
  body: JSON.stringify({
    "audio_url": "https://content.doitong.com/audio/showcase/v3/tools/dub_es.mp3"
  }),
});
let request = await res.json();
if (!res.ok) throw new Error(request.error.code + ": " + request.error.message);

// Not finished yet: long-poll until it is
while (request.status === "queued" || request.status === "running") {
  res = await fetch(API + "/requests/" + request.id + "?wait=20", { headers });
  request = await res.json();
}
if (request.status !== "succeeded") throw new Error(JSON.stringify(request.error));
console.log(request.outputs.map((o) => o.url), request.cost.credits + " API credits ($" + request.cost.usd + ")");
```

### Python

```python
import os
import requests

API = "https://api.doitong.com/v1"
headers = {"Authorization": "Bearer " + os.environ["DOITONG_API_KEY"]}

payload = {
    "audio_url": "https://content.doitong.com/audio/showcase/v3/tools/dub_es.mp3",
}

# Run the model; wait up to 20 s for the finished result in the same call
r = requests.post(API + "/run/mirage-api/avatar-x/reference-to-video", params={"wait": 20}, json=payload, headers=headers)
request = r.json()
if not r.ok:
    raise RuntimeError(request["error"]["code"] + ": " + request["error"]["message"])

# Not finished yet: long-poll until it is
while request["status"] in ("queued", "running"):
    request = requests.get(API + "/requests/" + request["id"], params={"wait": 20}, headers=headers).json()
if request["status"] != "succeeded":
    raise RuntimeError(request["error"])
print([o["url"] for o in request["outputs"]], request["cost"]["credits"], "API credits", "$" + request["cost"]["usd"])
```

### MCP

The MCP server at `https://api.doitong.com/v1/mcp` exposes the tools `search_models`, `get_model`, `quote`, `run`, `get_request`, `cancel_request`, `list_requests`, `create_upload` and `get_account`. A `run` call for this model:

```json
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "run",
    "arguments": {
      "model_id": "mirage-api/avatar-x/reference-to-video",
      "input": {
        "audio_url": "https://content.doitong.com/audio/showcase/v3/tools/dub_es.mp3"
      },
      "wait_seconds": 20
    }
  }
}
```

## Response

Every call returns a request object. `status` is one of `queued`, `running`, `succeeded`, `failed`, `canceled`. `outputs` lists the generated files with URLs on our storage (kept forever, or 7 days with `?storage=temporary`; `storage` says which); `output` is the model's own result object with the same URLs.

```json
{
  "id": "req_8k2m4q7x1z9c3v5b6n0p2r4t",
  "object": "request",
  "model": "mirage-api/avatar-x/reference-to-video",
  "status": "succeeded",
  "created_at": "2026-10-20T12:00:00Z",
  "started_at": "2026-10-20T12:00:02Z",
  "completed_at": "2026-10-20T12:00:09Z",
  "queue_position": null,
  "cost": {
    "credits": 3000,
    "usd": "3.00",
    "charged": 3000,
    "refunded": 0
  },
  "input": {
    "audio_url": "https://content.doitong.com/audio/showcase/v3/tools/dub_es.mp3"
  },
  "output": {
    "video": {
      "url": "https://content.doitong.com/dev-api/2026/10/20/req_8k2m4q7x1z9c3v5b6n0p2r4t/0-output.mp4",
      "content_type": "video/mp4",
      "file_name": "0-output.mp4",
      "file_size": 1843200
    }
  },
  "outputs": [
    {
      "type": "video",
      "url": "https://content.doitong.com/dev-api/2026/10/20/req_8k2m4q7x1z9c3v5b6n0p2r4t/0-output.mp4",
      "content_type": "video/mp4",
      "file_size": 1843200,
      "width": 1280,
      "height": 720,
      "duration": 5,
      "stored": true
    }
  ],
  "error": null,
  "metrics": {
    "inference_seconds": 6.8
  },
  "urls": {
    "self": "https://api.doitong.com/v1/requests/req_8k2m4q7x1z9c3v5b6n0p2r4t",
    "cancel": "https://api.doitong.com/v1/requests/req_8k2m4q7x1z9c3v5b6n0p2r4t/cancel"
  }
}
```

### Output fields (`output`)

| Field | Type | Description |
|---|---|---|
| `video` | object {url, content_type, file_name, file_size} |  |

## Related models

- [Avatar X](https://doitong.com/developers/models/mirage-api/avatar-x/text-to-video.md) (`mirage-api/avatar-x/text-to-video`): $54.00 / run
- [Kling AI Avatar 2.0 Pro](https://doitong.com/developers/models/kling-video/ai-avatar/v2/pro.md) (`kling-video/ai-avatar/v2/pro`): $0.115 / second of input audio
- [Sync Lipsync 3](https://doitong.com/developers/models/sync-lipsync/v3.md) (`sync-lipsync/v3`): $8.00 / minute of output video
- [VEED Fabric 1.0](https://doitong.com/developers/models/veed/fabric-1.0.md) (`veed/fabric-1.0`): from $0.08 / second of input audio
- [AI Avatar Multi](https://doitong.com/developers/models/ai-avatar/multi.md) (`ai-avatar/multi`): from $0.20 / second of output video
- [AI Avatar Multi Text](https://doitong.com/developers/models/ai-avatar/multi-text.md) (`ai-avatar/multi-text`): from $0.648 / run
- [AI Avatar Single Text](https://doitong.com/developers/models/ai-avatar/single-text.md) (`ai-avatar/single-text`): from $4.688 / run
- [Avatars Audio to Video](https://doitong.com/developers/models/argil/avatars/audio-to-video.md) (`argil/avatars/audio-to-video`): from $0.02 / second of input audio

## Links

- HTML page: https://doitong.com/developers/models/mirage-api/avatar-x/reference-to-video
- All models and guides for AI agents: https://doitong.com/developers/llms.txt
- OpenAPI 3.1 with this model's typed request body: https://doitong.com/developers/openapi.json?model=mirage-api/avatar-x/reference-to-video
- Errors: https://doitong.com/developers/docs/errors
- Model details as JSON: https://api.doitong.com/v1/models/mirage-api/avatar-x/reference-to-video