# 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/ur/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 |  |  | اختیاری animation ماخذ تصویر؛ اس کا aspect ratio آؤٹ پٹ کا ratio متعین کرتا ہے۔ اس کی شناخت، ترکیب اور ظاہری شکل بھی تخلیق کی رہنمائی کرتی ہے۔ |
| `audio_url` | `audio` | string (audio URL) \| null | no |  |  | اختیاری طور پر فراہم کردہ آڈیو جو آؤٹ پٹ میں تیار کردہ تقریر کی جگہ استعمال ہوتی ہے، جبکہ فراہم کردہ ریکارڈنگ برقرار رہتی ہے۔ اس میں بیانیہ، مکالمہ یا ساؤنڈ ٹریک شامل ہو سکتا ہے۔ |
| `negative_prompt` |  | string | no | `` |  | آؤٹ پٹ ویڈیو سے خارج کیا جانے والا ناپسندیدہ مواد یا artifacts۔ |
| `resolution` |  | enum (string) | no | `720p` | `720p`, `1080p`, `2k` | آؤٹ پٹ ریزولوشن tier: `2k`، 1:1، 4:3 یا 3:4 کے لیے 1440p row استعمال کرتا ہے؛ 16:9 یا 9:16 میں اس کا طویل کنارہ 2016 px ہوتا ہے۔ |
| `aspect_ratio` |  | enum (string) | no | `auto` | `auto`, `16:9`, `9:16`, `1:1`, `4:3`, `3:4` | فریم کا aspect ratio: نامزد ratio rendered ratio متعین کرتا ہے اور ہر حوالہ تصویر کو fit کرنے کے لیے center-crop کرتا ہے۔ حوالہ تصویر کا ratio برقرار رکھنے کے لیے `auto` منتخب کریں؛ تصویر نہ ہونے پر landscape (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