# Live Portrait API

> Huianimisha picha ya portrait kwa misemo iliyochukuliwa kutoka video ya uendeshaji, ikiwa na vidhibiti vya kina vya uso

Huhamisha mwendo wa uso kutoka video ya uendeshaji hadi portrait tuli, na kutoa video. Mbali na `video_url` na `image_url`, inatoa vidhibiti vya nambari vya kupepesa macho, nyusi, kukonyeza, mboni, maumbo ya mdomo (aaa, eee, woo), tabasamu na mzunguko wa kichwa katika pitch, yaw na roll. Chaguo za kupunguza na kushona kama `flag_do_crop` na `flag_pasteback` zinapatikana, na `dsize` huweka ukubwa wa matokeo (chaguomsingi 512).

- Model id: `live-portrait`
- Made by: Kuaishou
- Category: Lipsync & Avatars
- Output: video
- Charged by usage (up to $4.50 per run, typical $0.045; the rest of the hold is refunded): $0.00125 / second of processing time (cheapest run $0.045 (45 API credits))
- Run: `POST https://api.doitong.com/v1/run/live-portrait`
- Quote: `POST https://api.doitong.com/v1/quote/live-portrait`
- Docs page: https://doitong.com/sw/developers/models/live-portrait

## Pricing

Price: **$0.00125 / second of processing time**. Charged by actual usage at $0.00125 / second of processing time: up to $4.50 per run (the quote gives the maximum for your input), the rest is refunded automatically after the run. A typical run costs $0.045.

The full example input below holds up to $4.50 = 4500 API credits (up to 3600 s of processing time × $0.00125) when it starts; a typical run costs $0.045 (45 API credits).

Prices are the upstream price in USD, paid from the API balance in API credits (1000 API credits = 1 USD). This model is charged by usage: `POST https://api.doitong.com/v1/quote/live-portrait` with the same JSON body returns the most the run can cost for that input (`credits`, debited when the run starts); after the run you pay the usage the model reports and the rest is refunded automatically. An input whose maximum would exceed the per-run limit is refused with 422. 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 |
|---|---|---|---|---|---|---|
| `video_url` | `video` | string (video URL) | yes |  |  | URL ya video inayotumika kuendesha usawazishaji wa midomo. |
| `image_url` | `image` | string (image URL) | yes |  |  | URL ya picha kwa uhuishaji. |
| `blink` |  | number | no | `0` | -30 – 30 | Kiwango cha kupepesa macho. |
| `eyebrow` |  | number | no | `0` | -30 – 30 | Kiwango cha kuinua au kushusha nyusi. |
| `wink` |  | number | no | `0` | 0 – 25 | Kiwango cha kukonyeza. |
| `pupil_x` |  | number | no | `0` | -45 – 45 | Kiasi cha mwendo wa mboni mlalo. |
| `pupil_y` |  | number | no | `0` | -45 – 45 | Kiasi cha mwendo wa mboni wima. |
| `aaa` |  | number | no | `0` | -200 – 200 | Kiwango cha kufungua mdomo katika umbo la 'aaa'. |
| `eee` |  | number | no | `0` | -40 – 40 | Kiwango cha kuunda mdomo katika mkao wa 'eee'. |
| `woo` |  | number | no | `0` | -100 – 100 | Kiwango cha kuunda mdomo katika mkao wa 'woo'. |
| `smile` |  | number | no | `0` | -2 – 2 | Kiwango cha kutabasamu. |
| `flag_lip_zero` |  | boolean | no | `true` |  | Kufunga midomo kabla ya uhuishaji, kunakotumika tu wakati flag_eye_retargeting na flag_lip_retargeting zote zimewekwa kuwa False. |
| `rotate_pitch` |  | number | no | `0` | -45 – 45 | Kiasi cha mzunguko wa uso kwenye mhimili wa pitch. |
| `rotate_yaw` |  | number | no | `0` | -45 – 45 | Kiasi cha mzunguko wa uso kwenye mhimili wa yaw. |
| `rotate_roll` |  | number | no | `0` | -45 – 45 | Kiasi cha mzunguko wa uso kwenye mhimili wa roll. |
| `flag_eye_retargeting` |  | boolean | no | `false` |  | Kigeuza uelekezaji upya wa macho. |
| `flag_lip_retargeting` |  | boolean | no | `false` |  | Kigeuza uelekezaji upya wa midomo. |
| `flag_stitching` |  | boolean | no | `true` |  | Kigeuza kushona; kukiwezesha kunapendekezwa. |
| `flag_relative` |  | boolean | no | `true` |  | Kigeuza mwendo wa kadiri. |
| `flag_pasteback` |  | boolean | no | `true` |  | Chaguo la kubandika/kushona nyuma linaloweka kipande cha uso kilichohuishwa kwenye picha asili, kikikiondoa katika viwianishi vya kipande cha uso. |
| `flag_do_crop` |  | boolean | no | `true` |  | Hudhibiti ikiwa picha ya chanzo itakatwa katika nafasi ya viwianishi vya kipande cha uso. |
| `flag_do_rot` |  | boolean | no | `true` |  | Hudhibiti ikiwa mzunguko utafanywa wakati flag_do_crop ni true. |
| `dsize` |  | integer | no | `512` |  | Vipimo vya picha inayotokana. |
| `scale` |  | number | no | `2.3` |  | Kizidishi cha kipimo kinachotumika kwa kipande cha uso. |
| `vx_ratio` |  | number | no | `0` |  | Uwiano unaodhibiti uhamisho wa mlalo wa kipande cha uso. |
| `vy_ratio` |  | number | no | `-0.125` |  | Uwiano wa uwekaji wa wima wa kipande cha uso: ishara huamua mwelekeo, juu kwa thamani chanya na chini kwa thamani hasi. |
| `batch_size` |  | integer | no | `32` |  | Ukubwa wa kundi la modeli, wenye ubadilishanaji wa kasi na kumbukumbu: kuuongeza hutumia kumbukumbu zaidi badala ya utekelezaji wa haraka. |
| `enable_safety_checker` |  | boolean | no | `false` |  | Hudhibiti ikiwa ukaguzi wa usalama umewezeshwa. Ukiwa amilifu, kikagua huchakata picha ya ingizo ili kuthibitisha kuwa ina uso kabla ya uchakataji wa modeli. |

File parameters (`video`, `image`) 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
{
  "video": "https://content.doitong.com/video/showcase/v3/gen_fox_cartoon.mp4",
  "image": "https://content.doitong.com/images/showcase/v3/avatar/talking_avatar.jpg"
}
```

A fuller example:

```json
{
  "video_url": "https://content.doitong.com/video/showcase/v3/gen_fox_cartoon.mp4",
  "image_url": "https://content.doitong.com/images/showcase/v3/avatar/talking_avatar.jpg"
}
```

## 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/live-portrait?wait=20" \
  -H "Authorization: Bearer $DOITONG_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "video_url": "https://content.doitong.com/video/showcase/v3/gen_fox_cartoon.mp4",
    "image_url": "https://content.doitong.com/images/showcase/v3/avatar/talking_avatar.jpg"
  }'

# 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/live-portrait?wait=20", {
  method: "POST",
  headers,
  body: JSON.stringify({
    "video_url": "https://content.doitong.com/video/showcase/v3/gen_fox_cartoon.mp4",
    "image_url": "https://content.doitong.com/images/showcase/v3/avatar/talking_avatar.jpg"
  }),
});
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 = {
    "video_url": "https://content.doitong.com/video/showcase/v3/gen_fox_cartoon.mp4",
    "image_url": "https://content.doitong.com/images/showcase/v3/avatar/talking_avatar.jpg",
}

# Run the model; wait up to 20 s for the finished result in the same call
r = requests.post(API + "/run/live-portrait", 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": "live-portrait",
      "input": {
        "video_url": "https://content.doitong.com/video/showcase/v3/gen_fox_cartoon.mp4",
        "image_url": "https://content.doitong.com/images/showcase/v3/avatar/talking_avatar.jpg"
      },
      "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": "live-portrait",
  "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": 4500,
    "usd": "4.50",
    "charged": 4500,
    "refunded": 0
  },
  "input": {
    "video_url": "https://content.doitong.com/video/showcase/v3/gen_fox_cartoon.mp4",
    "image_url": "https://content.doitong.com/images/showcase/v3/avatar/talking_avatar.jpg"
  },
  "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} | Faili ya video iliyozalishwa. |

## Related models

- [Live Portrait · Image](https://doitong.com/developers/models/live-portrait/image.md) (`live-portrait/image`): $0.00125 / second of processing time
- [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
- [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

## Links

- HTML page: https://doitong.com/developers/models/live-portrait
- 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=live-portrait
- Errors: https://doitong.com/developers/docs/errors
- Model details as JSON: https://api.doitong.com/v1/models/live-portrait
