> ## Documentation Index
> Fetch the complete documentation index at: https://docs.creatify.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Boreal Video Generation API

> Creatify's video generation models: generate a video from a prompt, a start image, an audio track, or reference media.

## 🚀 Introduction

**Boreal** is Creatify's family of video generation models, built for video ads. Describe the scene in a prompt (subject, action, camera, dialogue and sound) and Boreal renders it, from text alone or from a start image, an audio track or reference media.

## Choose a model

One endpoint, `POST /api/boreal/`, serves both models. Pick one with `model`.

| Model | `model` | Best for |
| - | - | - |
| [Boreal-H3](https://docs.creatify.ai/api-documentation/boreal/model-boreal-h3.md) | `boreal-h3` | The highest quality: start and end frames, and reference to video from up to 9 images, 3 videos and 3 audio tracks. 5 to 15 seconds at 768p, 1088p or 2k. |
| [Boreal](https://docs.creatify.ai/api-documentation/boreal/model-boreal.md) | `boreal` (default) | Longer videos (up to 60 seconds at 720p) and video driven by an audio track. |

Prices and limits for both are under [Pricing, limits and retention](#-pricing-limits-and-retention).

***

## ⚙️ Quickstart Guide

### ✅ Prerequisites

Before you begin, ensure you have:

* A [Creatify](https://app.creatify.ai) account with **API access**
* Your **API credentials** (see [Quickstart](https://docs.creatify.ai/quickstart.md))

***

## 📝 Step 1: Submit a Video Generation Request

This request animates a start frame with Boreal-H3 at 2k; each model page has more examples and its full parameter list.

```bash Example Request theme={null}
curl --request POST \
    --url https://api.creatify.ai/api/boreal/ \
    --header 'Content-Type: application/json' \
    --header 'X-API-ID: your-api-id' \
    --header 'X-API-KEY: your-api-key' \
    --data '{
    "model": "boreal-h3",
    "prompt": "The chef places the final herb garnish on the salmon and slides the plate forward. Slow dolly-in, warm kitchen light, gentle steam.",
    "image_url": "https://d35ghwdno3nak3.cloudfront.net/tutorial/asset-generator/boreal-h3-chef.jpg",
    "resolution": "2k",
    "duration": 10,
    "webhook_url": "https://webhook.example"
  }'
```

```json Example Response theme={null}
{
    "id": "d7562b0f-e9db-4467-a11b-0169b6d56276",
    "created_at": "2026-10-11T16:24:01.524499-07:00",
    "updated_at": "2026-10-11T16:24:01.524499-07:00",
    "model": "boreal-h3",
    "prompt": "The chef places the final herb garnish on the salmon and slides the plate forward. Slow dolly-in, warm kitchen light, gentle steam.",
    "image_url": "https://cdn.creatify.ai/ai_tools_flow/c2pa/20261011/2fc51193d8734e6abaf2d70a3f5bc4d8.jpg",
    "end_image_url": null,
    "audio_url": null,
    "reference_image_urls": [],
    "reference_video_urls": [],
    "reference_audio_urls": [],
    "resolution": "2k",
    "aspect_ratio": "auto",
    "duration": 10.0,
    "negative_prompt": null,
    "prompt_enhancement": "auto",
    "webhook_url": "https://webhook.example",
    "status": "pending",
    "failed_reason": null,
    "video_output": null,
    "credits_used": 0,
    "progress": 0
}
```

> 🎬 The response includes a unique video ID. Save it to check status.

***

## ⏳ Step 2: Check Video Generation Status

Poll the status endpoint with the returned ID until `status` is `done`.

```bash Example Request theme={null}
curl --request GET  \
   --url https://api.creatify.ai/api/boreal/d7562b0f-e9db-4467-a11b-0169b6d56276/ \
   --header 'X-API-ID: your-api-id' \
   --header 'X-API-KEY: your-api-key'
```

```json Example Response theme={null}
{
    "id": "d7562b0f-e9db-4467-a11b-0169b6d56276",
    "created_at": "2026-10-11T16:24:01.524499-07:00",
    "updated_at": "2026-10-11T16:24:01.594409-07:00",
    "model": "boreal-h3",
    "prompt": "The chef places the final herb garnish on the salmon and slides the plate forward. Slow dolly-in, warm kitchen light, gentle steam.",
    "image_url": "https://cdn.creatify.ai/ai_tools_flow/c2pa/20261011/2fc51193d8734e6abaf2d70a3f5bc4d8.jpg",
    "end_image_url": null,
    "audio_url": null,
    "reference_image_urls": [],
    "reference_video_urls": [],
    "reference_audio_urls": [],
    "resolution": "2k",
    "aspect_ratio": "auto",
    "duration": 10.0,
    "negative_prompt": null,
    "prompt_enhancement": "auto",
    "webhook_url": "https://webhook.example",
    "status": "done",
    "failed_reason": null,
    "video_output": "https://d35ghwdno3nak3.cloudfront.net/tutorial/asset-generator/boreal-h3-chef.mp4",
    "credits_used": 26,
    "progress": 1
}
```

> ✅ When `status` is `done`, retrieve your video from the `video_output` field.

### 🔔 Webhook Option

Instead of polling, provide a `webhook_url` in the request. When processing completes, Boreal sends a POST request to your webhook with a payload like this:

```json theme={null}
{
    "id": "d7562b0f-e9db-4467-a11b-0169b6d56276",
    "status": "done",
    "failed_reason": "",
    "video_output": "https://d35ghwdno3nak3.cloudfront.net/tutorial/asset-generator/boreal-h3-chef.mp4"
}
```

***

## 🎯 Summary

| Step | Endpoint |
| - | - |
| Create Task | `POST /api/boreal/` |
| Check Status | `GET /api/boreal/{id}/` |
| API Reference | [Boreal Reference](https://docs.creatify.ai/api-reference/boreal/post-boreal.md) |

***

## 💳 Pricing, Limits and Retention

### Boreal

Billing is per started 10 seconds of video. Each resolution has a maximum video length, which applies to `duration` and to the length of `audio_url`:

| Resolution | Maximum length | Credits per 10 seconds |
| - | - | - |
| 720p | 60 seconds | 1 |
| 1080p | 30 seconds | 3 |
| 2k | 15 seconds | 12 |

For example, a 15-second 720p video costs 2 credits.

### Boreal-H3

Billing is per second of video, 5 to 15 seconds at every resolution. It is the same price as the `boreal-h3` models on the [Asset Generator](https://docs.creatify.ai/api-documentation/ai-generation/models/creatify.md):

| Resolution | Credits per second |
| - | - |
| 768p | 0.4 |
| 1088p | 1.2 |
| 2k | 2.6 |

Reference inputs are billed on top of the video:

* Reference videos cost 0.4 credits (768p) or 0.6 credits (1088p and 2k) per second of their combined length, counting up to 15 seconds.
* The first five reference images are free. Each one after that costs 0.2 credits.
* Reference audio is free.

The total is rounded up to the next half credit. For example, a 5-second 768p video costs 2 credits, and a 15-second 2k video costs 39 credits.

Credits are charged when rendering starts and refunded if the video fails.

### Output retention

Generated videos stay available for at least 7 days after the task finishes. Download any video you want to keep to your own storage.

***

## 🤝 Need Help?

If you run into any issues, check out our [API Reference](https://docs.creatify.ai/api-reference) or contact [api@creatify.ai](mailto:api@creatify.ai).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.