curl --request GET \
--url https://api.creatify.ai/api/boreal/{id}/ \
--header 'X-API-ID: <api-key>' \
--header 'X-API-KEY: <api-key>'import requests
url = "https://api.creatify.ai/api/boreal/{id}/"
headers = {
"X-API-ID": "<api-key>",
"X-API-KEY": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-ID': '<api-key>', 'X-API-KEY': '<api-key>'}};
fetch('https://api.creatify.ai/api/boreal/{id}/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.creatify.ai/api/boreal/{id}/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-ID: <api-key>",
"X-API-KEY: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.creatify.ai/api/boreal/{id}/"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-ID", "<api-key>")
req.Header.Add("X-API-KEY", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.creatify.ai/api/boreal/{id}/")
.header("X-API-ID", "<api-key>")
.header("X-API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.creatify.ai/api/boreal/{id}/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-ID"] = '<api-key>'
request["X-API-KEY"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"prompt": "<string>",
"status": "pending",
"failed_reason": "<string>",
"video_output": "<string>",
"credits_used": 123,
"progress": 123,
"model": "boreal",
"image_url": "<string>",
"end_image_url": "<string>",
"audio_url": "<string>",
"reference_image_urls": [
"<string>"
],
"reference_video_urls": [
"<string>"
],
"reference_audio_urls": [
"<string>"
],
"resolution": "720p",
"aspect_ratio": "auto",
"duration": 10,
"negative_prompt": "<string>",
"prompt_enhancement": "auto",
"webhook_url": "<string>"
}Get Boreal item by id
Generate a video from a prompt with Boreal (optional start image and audio
track) or Boreal-H3 (model: "boreal-h3": optional start and closing
frames, or reference images, videos and audio).
Async only: POST returns the job immediately; poll the detail route or
supply webhook_url.
curl --request GET \
--url https://api.creatify.ai/api/boreal/{id}/ \
--header 'X-API-ID: <api-key>' \
--header 'X-API-KEY: <api-key>'import requests
url = "https://api.creatify.ai/api/boreal/{id}/"
headers = {
"X-API-ID": "<api-key>",
"X-API-KEY": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-ID': '<api-key>', 'X-API-KEY': '<api-key>'}};
fetch('https://api.creatify.ai/api/boreal/{id}/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.creatify.ai/api/boreal/{id}/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-ID: <api-key>",
"X-API-KEY: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.creatify.ai/api/boreal/{id}/"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-ID", "<api-key>")
req.Header.Add("X-API-KEY", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.creatify.ai/api/boreal/{id}/")
.header("X-API-ID", "<api-key>")
.header("X-API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.creatify.ai/api/boreal/{id}/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-ID"] = '<api-key>'
request["X-API-KEY"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"prompt": "<string>",
"status": "pending",
"failed_reason": "<string>",
"video_output": "<string>",
"credits_used": 123,
"progress": 123,
"model": "boreal",
"image_url": "<string>",
"end_image_url": "<string>",
"audio_url": "<string>",
"reference_image_urls": [
"<string>"
],
"reference_video_urls": [
"<string>"
],
"reference_audio_urls": [
"<string>"
],
"resolution": "720p",
"aspect_ratio": "auto",
"duration": 10,
"negative_prompt": "<string>",
"prompt_enhancement": "auto",
"webhook_url": "<string>"
}Authorizations
API ID, from your settings page.
API Key, from your settings page.
Path Parameters
A UUID string identifying this Boreal.
Response
Describe the video: subject, action, camera, and any dialogue or sound it should contain. In a boreal-h3 reference render, refer to the references by type and order: Image 1, Image 2, Video 1, Audio 1.
pending- Pendingin_queue- In Queuerunning- Runningfailed- Faileddone- Donerejected- Rejected
pending, in_queue, running, failed, done, rejected Failed reason
Video output URL
Credits used in this API call
Progress of the job
boreal (default) or boreal-h3, Creatify's post-trained H3 model. boreal-h3 renders 768p, 1088p or 2k, 5 to 15 seconds, and adds a closing frame (end_image_url) and reference-to-video (reference_*_urls); it takes no audio_url or negative_prompt.
boreal- Borealboreal-h3- Boreal H3
boreal, boreal-h3 Optional start frame. boreal follows the image's own aspect ratio unless aspect_ratio names one, which centre-crops the image to it; boreal-h3 always follows the image's ratio.
2000boreal-h3 only: optional closing frame. Requires image_url.
2000boreal only: optional audio track ('mp3' or 'wav') that drives the video. When set, the video is as long as the audio, within the same per-resolution limit, and duration is ignored.
2000boreal-h3 only: up to 9 reference images for reference-to-video. A reference render needs at least one image or video reference and takes no image_url. The first 5 are free; each one after that costs 0.2 credits.
92000boreal-h3 only: up to 3 reference videos for reference-to-video, billed on top of the output per second of their combined length (counted up to 15 seconds): 0.4 credits at 768p, 0.6 at 1088p and 2k. The whole boreal-h3 price is rounded up to half a credit.
32000boreal-h3 only: up to 3 reference audio tracks, alongside at least one image or video reference.
32000Delivery tier. boreal: 720p (default), 1080p or 2k, where 2k is 2016 px on the long edge for 16:9 and 9:16, and the 1440p row for 1:1, 4:3 and 3:4; each started 10 seconds of video costs 1, 3 or 12 credits. boreal-h3: 768p (default), 1088p or 2k, where 2k is a 1440 px short edge; each second costs 0.4, 1.2 or 2.6 credits, plus any reference inputs, the same as on the asset generator API.
720p- 720p1080p- 1080p2k- 2k768p- 768p1088p- 1088p
720p, 1080p, 2k, 768p, 1088p Frame ratio. auto follows the start image's own ratio (boreal-h3: the first reference image's), and is 16:9 without an image. A named ratio renders that ratio; with a start image, boreal centre-crops the image to it, and boreal-h3 takes only auto.
auto- auto16:9- 16:99:16- 9:161:1- 1:14:3- 4:33:4- 3:4
auto, 16:9, 9:16, 1:1, 4:3, 3:4 Video length in seconds. boreal: greater than 0 and at most 60 at 720p, 30 at 1080p and 15 at 2k. boreal-h3: a whole number from 5 to 15.
boreal only: what the video should avoid.
auto (default) rewrites the prompt the way the Creatify app does for the model: boreal-h3 with the rewrite it was evaluated with, boreal for image and text renders (a render driven by audio_url keeps its prompt). none renders the prompt as sent.
auto- autonone- none
auto, none 200
