Loading API documentation
Wan 2.6 reference-to-video model.
wan/v2.6/reference-to-video
Wan 2.6 reference-to-video model.
Inference
Commercial use
Partner
Loading API documentation
Generate a video using reference videos for character/subject consistency (R2V).
WAN 2.6 R2V features:
Reference video requirements:
Prompt guidelines:
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("wan/v2.6/reference-to-video", {
input: {
prompt: "Dance battle between @Video1 and @Video2.",
video_urls: ["https://v3b.fal.media/files/b/0a86742f/9rVJtQ2ukp9cid8lheutF_output.mp4", "https://v3b.fal.media/files/b/0a867424/30OqWXFgHWqOwcP2OUwRx_output.mp4"]
},
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("wan/v2.6/reference-to-video", {
input: {
prompt: "Dance battle between @Video1 and @Video2.",
video_urls: ["https://v3b.fal.media/files/b/0a86742f/9rVJtQ2ukp9cid8lheutF_output.mp4", "https://v3b.fal.media/files/b/0a867424/30OqWXFgHWqOwcP2OUwRx_output.mp4"]
},
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("wan/v2.6/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("wan/v2.6/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 string* requiredUse @Video1, @Video2, @Video3 to reference subjects from your videos. Works for people, animals, or objects. For multi-shot prompts: '[0-3s] Shot 1. [3-6s] Shot 2.' Max 1500 characters.
Reference videos for subject consistency (1-3 videos). Videos' FPS must be at least 16 FPS.Reference in prompt as @Video1, @Video2, @Video3. Works for people, animals, or objects.
aspect_ratio AspectRatioEnumThe aspect ratio of the generated video. Default value: "16:9"
Possible enum values: 16:9, 9:16, 1:1, 4:3, 3:4
resolution ResolutionEnumVideo resolution tier. R2V only supports 720p and 1080p (no 480p). Default value: "1080p"
Possible enum values: 720p, 1080p
duration DurationEnumDuration of the generated video in seconds. R2V supports only 5 or 10 seconds (no 15s). Default value: "5"
Possible enum values: 5, 10
negative_prompt stringNegative prompt to describe content to avoid. Max 500 characters. Default value: ""
enable_prompt_expansion booleanWhether to enable prompt rewriting using LLM. Default value: true
multi_shots booleanWhen true (default), enables intelligent multi-shot segmentation for coherent narrative videos with multiple shots. When false, generates single continuous shot. Only active when enable_prompt_expansion is True. Default value: true
seed integerRandom seed for reproducibility. If None, a random seed is chosen.
enable_safety_checker booleanIf set to true, the safety checker will be enabled. Disabling it requires account authorization; unauthorized requests are always checked. Default value: true
{
"prompt": "Dance battle between @Video1 and @Video2.",
"video_urls": [
"https://v3b.fal.media/files/b/0a86742f/9rVJtQ2ukp9cid8lheutF_output.mp4",
"https://v3b.fal.media/files/b/0a867424/30OqWXFgHWqOwcP2OUwRx_output.mp4"
],
"aspect_ratio": "16:9",
"resolution": "1080p",
"duration": "5",
"negative_prompt": "low resolution, error, worst quality, low quality, defects",
"enable_prompt_expansion": true,
"multi_shots": true,
"enable_safety_checker": true
}The generated video file
seed integer* requiredThe seed used for generation
actual_prompt stringThe actual prompt used if prompt rewriting was enabled
{
"video": {
"url": "https://v3b.fal.media/files/b/0a86762b/iDknfPkLFSFwWkyMgJi0U_QIzjwBDQ.mp4",
"content_type": "video/mp4"
},
"seed": 175932751,
"actual_prompt": "Dance battle between Character1 and Character2, cinematic lighting, dynamic camera movement."
}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