# Hunyuan Video Foley API

> 根據文字描述為現有影片加入生成的音效

為 `video_url` 的影片生成音訊，由 `text_prompt` 引導，並可選擇提供預設為避免嘈雜或刺耳聲音的 `negative_prompt`。`guidance_scale` 介於 1 到 10，`num_inference_steps` 介於 10 到 100。回傳含音訊的影片。

- Model id: `hunyuan-video-foley`
- Made by: Tencent
- Category: Video to Audio
- Output: video
- Price per 10 seconds of your input video: $0.10 / 10 seconds of input video (cheapest run $0.10 (100 API credits))
- Run: `POST https://api.doitong.ru/v1/run/hunyuan-video-foley`
- Quote: `POST https://api.doitong.ru/v1/quote/hunyuan-video-foley`
- Docs page: https://doitong.com/zh-TW/developers/models/hunyuan-video-foley

## Pricing

Price: **$0.10 / 10 seconds of input video**. Price per 10 seconds of your input video: 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 $0.10 = 100 API credits (1 × 10 s input video × $0.10).

Prices are the upstream price in USD, paid from the API balance in API credits (1000 API credits = 1 USD). `POST https://api.doitong.ru/v1/quote/hunyuan-video-foley` 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 |
|---|---|---|---|---|---|---|
| `video_url` | `video` | string (video URL) | yes |  |  | 用作音訊生成來源的影片 URL。 |
| `text_prompt` |  | string | yes |  |  | 選填的文字，用於描述要產生的音訊。 |
| `negative_prompt` |  | string | no | `noisy, harsh` |  | 指定要排除之音訊特徵的負面提示詞。 |
| `enable_safety_checker` |  | boolean | no | `true` |  | 在呼叫端獲得授權的情況下，將此值設為 false 可放寬審核。 |
| `guidance_scale` |  | number | no | `4.5` | 1 – 10 | 音訊生成期間套用的引導比例。 |
| `num_inference_steps` |  | integer | no | `50` | 10 – 100 | 生成期間使用的推論步驟數量。 |
| `seed` |  | integer \| null | no |  |  | 使生成結果可重現的隨機種子。 |

File parameters (`video`) 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",
  "text_prompt": "A red fox trots through fresh snow at sunrise, soft golden light, shallow depth of field"
}
```

A fuller example:

```json
{
  "video_url": "https://content.doitong.com/video/showcase/v3/gen_fox_cartoon.mp4",
  "text_prompt": "A red fox trots through fresh snow at sunrise, soft golden light, shallow depth of field"
}
```

## 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.ru/v1/run/hunyuan-video-foley?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",
    "text_prompt": "A red fox trots through fresh snow at sunrise, soft golden light, shallow depth of field"
  }'

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

### JavaScript

```javascript
const API = "https://api.doitong.ru/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/hunyuan-video-foley?wait=20", {
  method: "POST",
  headers,
  body: JSON.stringify({
    "video_url": "https://content.doitong.com/video/showcase/v3/gen_fox_cartoon.mp4",
    "text_prompt": "A red fox trots through fresh snow at sunrise, soft golden light, shallow depth of field"
  }),
});
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.ru/v1"
headers = {"Authorization": "Bearer " + os.environ["DOITONG_API_KEY"]}

payload = {
    "video_url": "https://content.doitong.com/video/showcase/v3/gen_fox_cartoon.mp4",
    "text_prompt": "A red fox trots through fresh snow at sunrise, soft golden light, shallow depth of field",
}

# Run the model; wait up to 20 s for the finished result in the same call
r = requests.post(API + "/run/hunyuan-video-foley", 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.ru/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": "hunyuan-video-foley",
      "input": {
        "video_url": "https://content.doitong.com/video/showcase/v3/gen_fox_cartoon.mp4",
        "text_prompt": "A red fox trots through fresh snow at sunrise, soft golden light, shallow depth of field"
      },
      "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": "hunyuan-video-foley",
  "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": 100,
    "usd": "0.10",
    "charged": 100,
    "refunded": 0
  },
  "input": {
    "video_url": "https://content.doitong.com/video/showcase/v3/gen_fox_cartoon.mp4",
    "text_prompt": "A red fox trots through fresh snow at sunrise, soft golden light, shallow depth of field"
  },
  "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.ru/v1/requests/req_8k2m4q7x1z9c3v5b6n0p2r4t",
    "cancel": "https://api.doitong.ru/v1/requests/req_8k2m4q7x1z9c3v5b6n0p2r4t/cancel"
  }
}
```

### Output fields (`output`)

| Field | Type | Description |
|---|---|---|
| `video` | object {url, content_type, file_name, file_size} | 包含帶有音訊之生成影片的清單。 |

## Related models

- [Kling Video · Video to Audio](https://doitong.com/developers/models/kling-video/video-to-audio.md) (`kling-video/video-to-audio`): $0.035 / video
- [Mirelo SFX2.0 · Video to Audio](https://doitong.com/developers/models/mirelo-ai/sfx2.0/video-to-audio.md) (`mirelo-ai/sfx2.0/video-to-audio`): $0.01 / second of output audio
- [PixVerse Sound Effects](https://doitong.com/developers/models/pixverse/sound-effects.md) (`pixverse/sound-effects`): $0.10 / 5 seconds of input video
- [Sam Audio · Visual Separate](https://doitong.com/developers/models/sam-audio/visual-separate.md) (`sam-audio/visual-separate`): from $0.05 / 30 seconds of input video
- [Sonilo V1.1](https://doitong.com/developers/models/sonilo/v1.1/video-to-music.md) (`sonilo/v1.1/video-to-music`): $0.009 / second of output audio
- [Sonilo V1.1 Video to Sound Effects](https://doitong.com/developers/models/sonilo/v1.1/video-to-sound-effects.md) (`sonilo/v1.1/video-to-sound-effects`): $0.009 / second of input video
- [Sonilo V1.1 Video to Video Sound Effects](https://doitong.com/developers/models/sonilo/v1.1/video-to-video-sound-effects.md) (`sonilo/v1.1/video-to-video-sound-effects`): $0.009 / second of input video
- [ThinkSound](https://doitong.com/developers/models/thinksound.md) (`thinksound`): $0.001 / second of processing time

## Links

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