fal-ai/creatify-app/boreal

Inference

Private

Schema

LLMs

Playground API

About

Boreal

1. Calling the API#

Install the client#

The client provides a convenient way to interact with the model API.

npm install --save @fal-ai/client

Migrate to @fal-ai/client

The @fal-ai/serverless-client package has been deprecated in favor of @fal-ai/client. Install the new package and update your imports — see client setup.

Setup your API Key#

Set FAL_KEY as an environment variable in your runtime.

export FAL_KEY="YOUR_API_KEY"

Submit a request#

The client API handles the API submit protocol. It will handle the request status updates and return the result when the request is completed.

import { fal } from "@fal-ai/client";

const result = await fal.subscribe("fal-ai/creatify-app/boreal", {
  input: {
    prompt: "[VISUAL]
  A cinematic product close-up of a sparkling-water can on wet black stone.
  Condensation rolls down the can as the camera makes a slow half-orbit.

  [SPEECH]
  \"Clean flavor. Bright finish. Nothing extra.\"

  [SOUNDS]
  A crisp can opening, gentle fizz, and restrained electronic music.

  [TEXT]
  None."
  },
  logs: true,
  onQueueUpdate: (update) => {
    if (update.status === "IN_PROGRESS") {
      update.logs.map((log) => log.message).forEach(console.log);
    }
  },
});
console.log(result.data);
console.log(result.requestId);

2. Authentication#

The API uses an API Key for authentication. It is recommended you set the FAL_KEY environment variable in your runtime when possible.

API Key#

In an environment where you cannot set environment variables, you can configure the API key manually on the client.

import { fal } from "@fal-ai/client";

fal.config({
  credentials: "YOUR_FAL_KEY"
});

Protect your API Key

When running code on the client-side (e.g. in a browser, mobile app or GUI applications), make sure to not expose your FAL_KEY. Instead, use a server-side proxy to make requests to the API. For more information, check out our server-side integration guide.

3. Queue#

Long-running requests

For long-running requests, such as training jobs or models with slower inference times, it is recommended to check the Queue status and rely on Webhooks instead of blocking while waiting for the result.

Submit a request#

The client API provides a convenient way to submit requests to the model.

import { fal } from "@fal-ai/client";

const { request_id } = await fal.queue.submit("fal-ai/creatify-app/boreal", {
  input: {
    prompt: "[VISUAL]
  A cinematic product close-up of a sparkling-water can on wet black stone.
  Condensation rolls down the can as the camera makes a slow half-orbit.

  [SPEECH]
  \"Clean flavor. Bright finish. Nothing extra.\"

  [SOUNDS]
  A crisp can opening, gentle fizz, and restrained electronic music.

  [TEXT]
  None."
  },
  webhookUrl: "https://optional.webhook.url/for/results",
});

Fetch request status#

You can fetch the status of a request to check if it is completed or still in progress.

import { fal } from "@fal-ai/client";

const status = await fal.queue.status("fal-ai/creatify-app/boreal", {
  requestId: "764cabcf-b745-4b3e-ae38-1200304cf45b",
  logs: true,
});

Get the result#

Once the request is completed, you can fetch the result. See the Output Schema for the expected result format.

import { fal } from "@fal-ai/client";

const result = await fal.queue.result("fal-ai/creatify-app/boreal", {
  requestId: "764cabcf-b745-4b3e-ae38-1200304cf45b"
});
console.log(result.data);
console.log(result.requestId);

4. Files#

Some attributes in the API accept file URLs as input. Whenever that's the case you can pass your own URL or a Base64 data URI.

Data URI (base64)#

You can pass a Base64 data URI as a file input. The API will handle the file decoding for you. Keep in mind that for large files, this alternative although convenient can impact the request performance.

Hosted files (URL)#

You can also pass your own URLs as long as they are publicly accessible. Be aware that some hosts might block cross-site requests, rate-limit, or consider the request as a bot.

Uploading files#

We provide a convenient file storage that allows you to upload files and use them in your requests. You can upload files using the client API and use the returned URL in your requests.

import { fal } from "@fal-ai/client";

const file = new File(["Hello, World!"], "hello.txt", { type: "text/plain" });
const url = await fal.storage.upload(file);

Auto uploads

The client will auto-upload the file for you if you pass a binary object (e.g. File, Data).

Read more about file handling in our file upload guide.

5. Schema#

Input#

prompt string* required

Direction for the visuals, spoken dialogue, sounds, and on-screen text. Structure it with [VISUAL], [SPEECH], [SOUNDS], and [TEXT] sections for best results. English is the validated language.

image_url string

Optional reference image to animate. Guides identity, composition, and appearance; the output follows this image's aspect ratio.

audio_url string

Optional driving audio (narration, dialogue, or a soundtrack). When provided it is preserved in the output instead of generated speech.

negative_prompt string

Content or artifacts to avoid in the generated video. Default value: ""

resolution ResolutionEnum

Delivery 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. Default value: "720p"

Possible enum values: 720p, 1080p, 2k

aspect_ratio AspectRatioEnum

Frame ratio. auto follows the reference image's own ratio, and is landscape (16:9) when there is no image. A named ratio renders that ratio; with an image it centre-crops the image to it. Default value: "auto"

Possible enum values: auto, 16:9, 9:16, 1:1, 4:3, 3:4

duration float

Length of the generated video in seconds at 24 FPS, rounded by the model to the nearest legal frame count (5 s -> 121 frames, 10 s -> 241, 15 s -> 361). With audio_url, the first duration seconds of the audio are used; shorter audio is padded with silence. Default value: 10

manifest_disclosure boolean

Add a visible AI-generated disclosure label to the video. Invisible C2PA metadata and watermarking are always applied.

{
  "prompt": "[VISUAL]\nA cinematic product close-up of a sparkling-water can on wet black stone.\nCondensation rolls down the can as the camera makes a slow half-orbit.\n\n[SPEECH]\n\"Clean flavor. Bright finish. Nothing extra.\"\n\n[SOUNDS]\nA crisp can opening, gentle fizz, and restrained electronic music.\n\n[TEXT]\nNone.",
  "image_url": "https://storage.googleapis.com/falserverless/example_inputs/creatify/aurora/input_.png",
  "audio_url": "https://storage.googleapis.com/falserverless/example_inputs/creatify/aurora/input.wav",
  "resolution": "720p",
  "aspect_ratio": "auto",
  "duration": 10
}

Output#

video VideoFile* required

The generated video with synchronized native audio.

{
  "video": {
    "content_type": "video/mp4",
    "file_name": "output.mp4",
    "url": "https://storage.googleapis.com/falserverless/example_outputs/creatify/aurora/output.mp4"
  }
}

Other types#

VideoFile#

url string* required

The URL where the file can be downloaded from.

content_type string

The mime type of the file.

file_name string

The name of the file. It will be auto-generated if not provided.

file_size integer

The size of the file in bytes.

width integer

The width of the video

height integer

The height of the video

fps float

The FPS of the video

duration float

The duration of the video

num_frames integer

The number of frames in the video

AuroraInputModel#

image_url string* required

The URL of the image file to be used for video generation.

audio_url string* required

The URL of the audio file to be used for video generation.

prompt string

A text prompt to guide the video generation process.

guidance_scale float

Guidance scale to be used for text prompt adherence. Default value: 1

audio_guidance_scale float

Guidance scale to be used for audio adherence. Default value: 2

resolution ResolutionEnum

The resolution of the generated video. Default value: "720p"

Possible enum values: 480p, 720p

AuroraOutputModel#

video VideoFile* required

The generated video file.

fal-ai/creatify-app/boreal

Table of contents

1. Calling the API

2. Authentication

3. Queue

4. Files

5. Schema

About

1. Calling the API#

Install the client#

Migrate to @fal-ai/client

Setup your API Key#

Submit a request#

2. Authentication#

API Key#

Protect your API Key

3. Queue#

Long-running requests

Submit a request#

Fetch request status#

Get the result#

4. Files#

Data URI (base64)#

Hosted files (URL)#

Uploading files#

Auto uploads

5. Schema#

Input#

Output#

Other types#

VideoFile#

AuroraInputModel#

AuroraOutputModel#