Skip to main content
GET
cURL

Authorizations

X-API-ID
string
header
required

API ID, from your settings page.

X-API-KEY
string
header
required

API Key, from your settings page.

Path Parameters

id
string<uuid>
required

A UUID string identifying this Boreal.

Response

200 - application/json
id
string<uuid>
required
read-only
created_at
string<date-time>
required
read-only
updated_at
string<date-time>
required
read-only
prompt
string
required

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.

status
enum<string>
required
  • pending - Pending
  • in_queue - In Queue
  • running - Running
  • failed - Failed
  • done - Done
  • rejected - Rejected
Available options:
pending,
in_queue,
running,
failed,
done,
rejected
failed_reason
string
required
read-only

Failed reason

video_output
string | null
required
read-only

Video output URL

credits_used
number
required
read-only

Credits used in this API call

progress
number<double>
required
read-only

Progress of the job

model
enum<string>
default:boreal

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 - Boreal
  • boreal-h3 - Boreal H3
Available options:
boreal,
boreal-h3
image_url
string<uri> | null

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.

Maximum string length: 2000
end_image_url
string<uri> | null

boreal-h3 only: optional closing frame. Requires image_url.

Maximum string length: 2000
audio_url
string<uri> | null

boreal 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.

Maximum string length: 2000
reference_image_urls
string<uri>[]

boreal-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.

Maximum array length: 9
Maximum string length: 2000
reference_video_urls
string<uri>[]

boreal-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.

Maximum array length: 3
Maximum string length: 2000
reference_audio_urls
string<uri>[]

boreal-h3 only: up to 3 reference audio tracks, alongside at least one image or video reference.

Maximum array length: 3
Maximum string length: 2000
resolution
enum<string>

Delivery 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 - 720p
  • 1080p - 1080p
  • 2k - 2k
  • 768p - 768p
  • 1088p - 1088p
Available options:
720p,
1080p,
2k,
768p,
1088p
aspect_ratio
enum<string>
default:auto

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 - auto
  • 16:9 - 16:9
  • 9:16 - 9:16
  • 1:1 - 1:1
  • 4:3 - 4:3
  • 3:4 - 3:4
Available options:
auto,
16:9,
9:16,
1:1,
4:3,
3:4
duration
number<double>
default:10

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.

negative_prompt
string | null

boreal only: what the video should avoid.

prompt_enhancement
enum<string>

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 - auto
  • none - none
Available options:
auto,
none
webhook_url
string<uri> | null
Maximum string length: 200