Generate a video from reference images, videos, audio, a document or a page.
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("alibaba/wan-3.0/reference-to-video", {
input: {},
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("alibaba/wan-3.0/reference-to-video", {
input: {},
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("alibaba/wan-3.0/reference-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("alibaba/wan-3.0/reference-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 stringText prompt directing how the reference media is used. Reference media can be addressed positionally, e.g. 'the subject in Image 1 walks past Video 1'.
resolution ResolutionEnumOutput video resolution tier. Default value: "1080p"
Possible enum values: 480p, 720p, 1080p
aspect_ratio AspectRatioEnumOutput aspect ratio, or adaptive selection. Default value: "adaptive"
Possible enum values: adaptive, 16:9, 4:3, 1:1, 3:4, 9:16
duration integerOutput duration in seconds. Set to null for smart duration, which lets the model pick a length from the prompt and reference media. Default value: 5
audio booleanInclude generated audio. Default value: true
enable_prompt_expansion booleanEnable intelligent prompt rewriting. Disabling it can save roughly 20-60 seconds of latency but is likely to degrade generation quality. Default value: true
enable_thinking booleanEnable enhanced reasoning before generation.
seed integerenable_safety_checker booleanEnable content moderation for input and output. Disabling it requires account authorization; unauthorized requests are always checked. Default value: true
Up to 10 reference image URLs.
Up to 5 reference video URLs totaling at most 15 seconds. Each clip must be at least 16 fps. Input video duration is billed in addition to output duration.
Up to 5 reference audio URLs totaling at most 15 seconds.
file_url stringDocument URL to base the video on. Requires enable_thinking=true.
web_url stringPublic webpage URL to base the video on. Requires enable_thinking=true. Only pages that do not require login can be read.
{
"resolution": "1080p",
"aspect_ratio": "adaptive",
"duration": 5,
"audio": true,
"enable_prompt_expansion": true,
"enable_safety_checker": true
}The generated video file.
seed integer* requiredThe seed used for generation.
duration float* requiredGenerated video duration in seconds.
actual_prompt string{
"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.
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