curl --request GET \
--url https://api.creatify.ai/api/boreal/ \
--header 'X-API-ID: <api-key>' \
--header 'X-API-KEY: <api-key>'import requests
url = "https://api.creatify.ai/api/boreal/"
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/', 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/",
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/"
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/")
.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/")
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,
"image_url": "<string>",
"audio_url": "<string>",
"resolution": "720p",
"aspect_ratio": "auto",
"duration": 10,
"negative_prompt": "<string>",
"webhook_url": "<string>"
}
]Get Boreal items
Retrieve a list of videos, with an optional ids param to filter vdieo by their UUIDs.
curl --request GET \
--url https://api.creatify.ai/api/boreal/ \
--header 'X-API-ID: <api-key>' \
--header 'X-API-KEY: <api-key>'import requests
url = "https://api.creatify.ai/api/boreal/"
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/', 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/",
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/"
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/")
.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/")
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,
"image_url": "<string>",
"audio_url": "<string>",
"resolution": "720p",
"aspect_ratio": "auto",
"duration": 10,
"negative_prompt": "<string>",
"webhook_url": "<string>"
}
]Authorizations
API ID, from your settings page.
API Key, from your settings page.
Query Parameters
Comma-separated list of UUIDs to filter. Maximum 100 entries allowed.
1Response
Describe the video: subject, action, camera, and any dialogue or sound it should contain.
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
Optional start frame. The video follows the image's own aspect ratio unless aspect_ratio names one, which centre-crops the image to it.
2000Optional 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.
2000Delivery tier. 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 credit at 720p, 3 credits at 1080p and 12 credits at 2k.
720p- 720p1080p- 1080p2k- 2k
720p, 1080p, 2k Frame ratio. auto follows the start image's own ratio, and is 16:9 without an image. A named ratio renders that ratio; with an image it centre-crops the image to it.
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, greater than 0 and at most 60 at 720p, 30 at 1080p and 15 at 2k.
What the video should avoid.
200
