Generate a video through keyframe images pinned to frame positions.
The client provides a convenient way to interact with the model API.
npm install --save @fal-ai/clientThe @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.
Set FAL_KEY as an environment variable in your runtime.
export FAL_KEY="YOUR_API_KEY"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("blackforestlabs/flux-3-max/keyframes-to-video", {
input: {
prompt: "The woman picks up a brown felt fedora, lifts it onto her head with both hands and adjusts the brim, smiling at the camera. Soft studio light against a plain gray wall.",
keyframes: [{
frame_index: 0,
image_url: "https://storage.googleapis.com/falserverless/example_inputs/veo31-flf2v-input-1.jpeg"
}, {
frame_index: 120,
image_url: "https://storage.googleapis.com/falserverless/example_inputs/veo31-flf2v-input-2.jpeg"
}]
},
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);The API uses an API Key for authentication. It is recommended you set the FAL_KEY environment variable in your runtime when possible.
import { fal } from "@fal-ai/client";
fal.config({
credentials: "YOUR_FAL_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.
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("blackforestlabs/flux-3-max/keyframes-to-video", {
input: {
prompt: "The woman picks up a brown felt fedora, lifts it onto her head with both hands and adjusts the brim, smiling at the camera. Soft studio light against a plain gray wall.",
keyframes: [{
frame_index: 0,
image_url: "https://storage.googleapis.com/falserverless/example_inputs/veo31-flf2v-input-1.jpeg"
}, {
frame_index: 120,
image_url: "https://storage.googleapis.com/falserverless/example_inputs/veo31-flf2v-input-2.jpeg"
}]
},
webhookUrl: "https://optional.webhook.url/for/results",
});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("blackforestlabs/flux-3-max/keyframes-to-video", {
requestId: "764cabcf-b745-4b3e-ae38-1200304cf45b",
logs: true,
});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("blackforestlabs/flux-3-max/keyframes-to-video", {
requestId: "764cabcf-b745-4b3e-ae38-1200304cf45b"
});
console.log(result.data);
console.log(result.requestId);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.
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.
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.
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);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.
prompt string* requiredThe text prompt describing how the video moves between keyframes.
Keyframe images pinned to frame positions in the generated video. Up to 10 keyframes with unique frame_index values.
duration DurationEnumDuration of the generated video in seconds. Default value: "5"
Possible enum values: 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20
resolution ResolutionEnumResolution of the generated video. Default value: "720p"
Possible enum values: 720p, 1080p
reasoning_level ReasoningLevelEnumHow much effort the harness spends reasoning about the given prompt. Higher reasoning effort means slower generation time. Default value: "high"
Possible enum values: low, high
aspect_ratio AspectRatioEnumAspect ratio of the generated video. auto uses 16:9 for text prompts and follows the first image otherwise. Default value: "auto"
Possible enum values: auto, 21:9, 2:1, 16:9, 4:3, 1:1, 3:4, 9:16
generate_audio booleanWhether to generate audio for the video. Default value: true
seed integerThe seed to use for the generation. Random when not provided.
{
"prompt": "The woman picks up a brown felt fedora, lifts it onto her head with both hands and adjusts the brim, smiling at the camera. Soft studio light against a plain gray wall.",
"keyframes": [
{
"frame_index": 0,
"image_url": "https://storage.googleapis.com/falserverless/example_inputs/veo31-flf2v-input-1.jpeg"
},
{
"frame_index": 120,
"image_url": "https://storage.googleapis.com/falserverless/example_inputs/veo31-flf2v-input-2.jpeg"
}
],
"duration": 5,
"resolution": "720p",
"reasoning_level": "high",
"aspect_ratio": "auto",
"generate_audio": true
}The generated video.
seed integer* requiredThe seed used for the generation.
inference: seconds the model spent denoising the video. Excludes prompt expansion, decoding and upload.
{
"video": {
"height": 1088,
"content_type": "video/mp4",
"width": 800,
"duration": 5.041666666666667,
"url": "https://v3b.fal.media/files/b/0aad95e6/8CP6rEBGhIRsmaiPP1Y9Q_alligator.mp4",
"num_frames": 121,
"fps": 24
}
}url string* requiredThe URL where the file can be downloaded from.
content_type stringThe mime type of the file.
file_name stringThe name of the file. It will be auto-generated if not provided.
file_size integerThe size of the file in bytes.
width integerThe width of the video
height integerThe height of the video
fps floatThe FPS of the video
duration floatThe duration of the video
num_frames integerThe number of frames in the video
image_url string* requiredURL of the keyframe image (PNG, JPEG, or WebP).
frame_index integer* requiredFrame position of this keyframe in the generated 24 fps video. Must be unique and at most duration * 24.