# Boreal API

> 具原生同步音訊的文字轉影片，適用於產品、UGC 與簡報者片段，可選影像與音訊

從最多 5000 個字元的 `prompt` 建立含自身音訊的影片，並分成視覺、語音、聲音和文字區段。選用 `image_url` 和 `audio_url` 可加入參考影像與驅動音訊。時長為 1 到 20 秒；解析度為 720p、1080p 或 2k；長寬比支援 auto、16:9、9:16、1:1、4:3 或 3:4。

- Model id: `creatify/boreal`
- Made by: Creatify
- Category: Text to Video
- Output: video
- Price per second of your output video: from $0.01 / second of output video (cheapest run $0.01 (10 API credits))
- Run: `POST https://api.doitong.com/v1/run/creatify/boreal`
- Quote: `POST https://api.doitong.com/v1/quote/creatify/boreal`
- Docs page: https://doitong.com/zh-TW/developers/models/creatify/boreal

## Pricing

Price: **from $0.01 / second of output video** (the lowest tier; the quote prices your exact input). Price per second of your output 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.

Price by tier:

- 720p: $0.01 / second of output video
- 1080p: $0.03 / second of output video
- 2k: $0.12 / second of output video

The full example input below costs $0.10 = 100 API credits (10 s output video × $0.01 (720p)).

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/creatify/boreal` 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 |
|---|---|---|---|---|---|---|
| `prompt` |  | string | yes |  | 1 – 5000 characters | 涵蓋場景外觀、對話、音訊效果及畫面文字的生成指示；English 已完成驗證。為取得最佳結果，請將視覺指示整理在 `[VISUAL]` 下、對話整理在 `[SPEECH]` 下、聲音指示整理在 `[SOUNDS]` 下，並將顯示文字整理在 `[TEXT]` 下。 |
| `image_url` | `image` | string (image URL) \| null | no |  |  | 選用的動畫來源圖像，其寬高比決定輸出比例。其識別特徵、構圖和外觀也會引導生成。 |
| `audio_url` | `audio` | string (audio URL) \| null | no |  |  | 選用的驅動音訊，用於在保留所提供錄音的同時取代輸出中的生成語音。可包含旁白、對話或配樂。 |
| `negative_prompt` |  | string | no | `` |  | 要從輸出影片中排除的不需要內容或瑕疵。 |
| `resolution` |  | enum (string) | no | `720p` | `720p`, `1080p`, `2k` | 輸出解析度級別：`2k` 在 1:1、4:3 或 3:4 下使用 1440p 列；在 16:9 或 9:16 下，其較長邊為 2016 px。 |
| `aspect_ratio` |  | enum (string) | no | `auto` | `auto`, `16:9`, `9:16`, `1:1`, `4:3`, `3:4` | 影格寬高比：指定的比例會決定算繪比例，並將任何參考圖像置中裁切以符合比例。選擇 `auto` 可保留參考圖像比例；若未提供圖像，則回退至橫向（16:9）。 |
| `duration` |  | number | no | `10` | 1 – 20 | 要求的影片持續時間（以秒計），輸出為 24 FPS，並四捨五入至最接近的允許影格數：5 s 會變成 121 影格，10 s 會變成 241，15 s 會變成 361。當 `audio_url` 提供的音訊短於 `duration` 時，會以靜音填補不足部分；否則會從音訊開頭擷取 `duration` 秒。 |
| `manifest_disclosure` |  | boolean | no | `false` |  | 影片上標示 `AI-generated` 的可見揭露標記。無論此設定為何，都會套用 C2PA 中繼資料與不可見浮水印。 |
| `enable_safety_checker` |  | boolean | no | `true` |  | 在呼叫端獲得授權的情況下，將此值設為 false 可放寬審核。 |

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

A fuller example:

```json
{
  "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.com/v1/run/creatify/boreal?wait=20" \
  -H "Authorization: Bearer $DOITONG_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "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.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/creatify/boreal?wait=20", {
  method: "POST",
  headers,
  body: JSON.stringify({
    "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.com/v1"
headers = {"Authorization": "Bearer " + os.environ["DOITONG_API_KEY"]}

payload = {
    "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/creatify/boreal", 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": "creatify/boreal",
      "input": {
        "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": "creatify/boreal",
  "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": {
    "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,
      "width": 1024,
      "height": 768,
      "fps": 1.0,
      "duration": 5,
      "num_frames": 1
    }
  },
  "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, width, height, fps, duration, num_frames} | 包含與視覺同步之原生音訊的輸出影片。 |

## Related models

- [FLUX 3 Max Text to Video](https://doitong.com/developers/models/blackforestlabs/flux-3-max/text-to-video.md) (`blackforestlabs/flux-3-max/text-to-video`): from $0.0425 / second of output video
- [Grok Imagine Video 1.5 Text to Video](https://doitong.com/developers/models/xai/grok-imagine-video/v1.5/text-to-video.md) (`xai/grok-imagine-video/v1.5/text-to-video`): from $0.08 / second
- [Kling 3.0 Pro Text to Video](https://doitong.com/developers/models/kling-video/v3/pro/text-to-video.md) (`kling-video/v3/pro/text-to-video`): from $0.112 / second
- [LTX 2.5 Pro Text to Video](https://doitong.com/developers/models/lightricks/ltx-2.5/text-to-video/pro.md) (`lightricks/ltx-2.5/text-to-video/pro`): from $0.12 / second
- [MiniMax H3 Text to Video](https://doitong.com/developers/models/minimax/h3/text-to-video.md) (`minimax/h3/text-to-video`): from $0.05 / second
- [Seedance 2.0 Fast Text to Video](https://doitong.com/developers/models/bytedance/seedance-2.0/fast/text-to-video.md) (`bytedance/seedance-2.0/fast/text-to-video`): from $0.113 / second
- [Seedance 2.0 Text to Video](https://doitong.com/developers/models/bytedance/seedance-2.0/text-to-video.md) (`bytedance/seedance-2.0/text-to-video`): from $0.141 / second
- [Veo 3.1](https://doitong.com/developers/models/veo3.1.md) (`veo3.1`): from $0.20 / second

## Links

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