Text To Video Draft
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/text-to-video/draft", {
input: {
prompt: "A red panda walks along a mossy log in a sunlit forest, one continuous unbroken shot."
},
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/text-to-video/draft", {
input: {
prompt: "A red panda walks along a mossy log in a sunlit forest, one continuous unbroken shot."
},
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/text-to-video/draft", {
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/text-to-video/draft", {
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 the draft video.
aspect_ratio AspectRatioEnumAspect ratio of the generated draft. auto lets the model choose. Default value: "auto"
Possible enum values: auto, 21:9, 2:1, 16:9, 4:3, 1:1, 3:4, 9:16
duration DurationEnumDraft duration in whole seconds from 5 through 20, or auto. Default value: "auto"
Possible enum values: auto, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20
generate_audio booleanWhether to generate audio for the draft video. Default value: true
safety_tolerance integerThe safety tolerance level for the generated video. 0 is the strictest and 4 is the most permissive. Default value: 2
{
"prompt": "A red panda walks along a mossy log in a sunlit forest, one continuous unbroken shot.",
"aspect_ratio": "auto",
"duration": "auto",
"generate_audio": true,
"safety_tolerance": 2
}The draft video.
Durable encrypted cache bundle; pass it to draft-enhance for a full-quality render. Absent when the partner did not return a cache bundle for this draft.
{
"video": {
"url": "",
"content_type": "image/png",
"file_name": "z9RV14K95DvU.png",
"file_size": 4404019
}
}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.