fal-ai/ltx-2.3-22b/distilled/reference-video-to-video
About
Generate a video from a reference video and text prompt using distilled LoRA.
1. Calling the API#
Install the client#
The client provides a convenient way to interact with the model API.
npm install --save @fal-ai/clientMigrate to @fal-ai/client
The @fal-ai/serverless-client package has been deprecated in favor of @fal-ai/client. Please check the migration guide for more information.
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/ltx-2.3-22b/distilled/reference-video-to-video", {
input: {
prompt: "style: cinematic/realistic. A man wearing a baseball cap walks through a modern town. He holds a coffee cup.",
video_url: "https://v3b.fal.media/files/b/0a963ecf/eVoII1AsconU8SpPx5xoE_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);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#
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#
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/ltx-2.3-22b/distilled/reference-video-to-video", {
input: {
prompt: "style: cinematic/realistic. A man wearing a baseball cap walks through a modern town. He holds a coffee cup.",
video_url: "https://v3b.fal.media/files/b/0a963ecf/eVoII1AsconU8SpPx5xoE_output.mp4"
},
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/ltx-2.3-22b/distilled/reference-video-to-video", {
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/ltx-2.3-22b/distilled/reference-video-to-video", {
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* requiredThe prompt to generate the video from.
video_url string* requiredThe URL of the video to reference.
audio_url stringAn optional URL of an audio to use as the audio for the video. If not provided, any audio present in the input video will be used.
image_url stringAn optional URL of an image to use as the first frame of the video.
end_image_url stringThe URL of the image to use as the end of the video.
match_video_length booleanWhen enabled, the number of frames will be calculated based on the video duration and FPS. When disabled, use the specified num_frames. Default value: true
num_frames integerThe number of frames to generate. Default value: 121
The size of the generated video. Default value: auto
Possible enum values: auto, square_hd, square, portrait_4_3, portrait_16_9, landscape_4_3, landscape_16_9
Note: For custom image sizes, you can pass the width and height as an object:
"image_size": {
"width": 1280,
"height": 720
}generate_audio booleanWhether to generate audio for the video. Default value: true
use_multiscale booleanWhether to use multi-scale generation. If True, the model will generate the video at a smaller scale first, then use the smaller video to guide the generation of a video at or above your requested size. This results in better coherence and details. Default value: true
match_input_fps booleanWhen true, match the output FPS to the input video's FPS instead of using the default target FPS. Default value: true
fps floatThe frames per second of the generated video. Default value: 24
scheduler SchedulerEnumThe scheduler to use. Default value: "beta"
Possible enum values: ltx2, linear_quadratic, beta
acceleration AccelerationEnumThe acceleration level to use. Default value: "none"
Possible enum values: none, regular, high, full
camera_lora CameraLoRAEnumThe camera LoRA to use. This allows you to control the camera movement of the generated video more accurately than just prompting the model to move the camera. Default value: "none"
Possible enum values: dolly_in, dolly_out, dolly_left, dolly_right, jib_up, jib_down, static, none
camera_lora_scale floatThe scale of the camera LoRA to use. This allows you to control the camera movement of the generated video more accurately than just prompting the model to move the camera. Default value: 1
negative_prompt stringThe negative prompt to generate the video from. Default value: "news broadcast, 3d animation, computer graphics, pc game, console game, video game, cartoon, childish, watermark, logo, text, on screen text, subtitles, titles, signature, slowmo, static"
seed integerThe seed for the random number generator.
enable_prompt_expansion booleanWhether to enable prompt expansion. Default value: true
enable_safety_checker booleanWhether to enable the safety checker. Default value: true
video_output_type VideoOutputTypeEnumThe output type of the generated video. Default value: "X264 (.mp4)"
Possible enum values: X264 (.mp4), VP9 (.webm), PRORES4444 (.mov), GIF (.gif)
video_quality VideoQualityEnumThe quality of the generated video. Default value: "high"
Possible enum values: low, medium, high, maximum
video_write_mode VideoWriteModeEnumThe write mode of the generated video. Default value: "balanced"
Possible enum values: fast, balanced, small
sync_mode booleanIf True, the media will be returned as a data URI and the output data won't be available in the request history.
distill_lora_second_pass_scale floatThe scale of the distill LoRA to use for the second and subsequent passes. Default value: 0.5
video_strength floatVideo conditioning strength. Lower values represent more freedom given to the model to change the video content. Default value: 1
audio_strength floatAudio conditioning strength. Lower values represent more freedom given to the model to change the audio content. Default value: 1
preprocessor PreprocessorEnumThe preprocessor to use for the generation. Default value: "none"
Possible enum values: depth, canny, pose, none
ic_lora_type IC-LoRATypeEnumThe IC LoRA type to use for the generation. Default value: "union"
Possible enum values: match_preprocessor, union, detailer, none
{
"prompt": "style: cinematic/realistic. A man wearing a baseball cap walks through a modern town. He holds a coffee cup.",
"video_url": "https://v3b.fal.media/files/b/0a963ecf/eVoII1AsconU8SpPx5xoE_output.mp4",
"match_video_length": true,
"num_frames": 121,
"video_size": "auto",
"generate_audio": true,
"use_multiscale": true,
"match_input_fps": true,
"fps": 24,
"scheduler": "beta",
"acceleration": "none",
"camera_lora": "none",
"camera_lora_scale": 1,
"negative_prompt": "news broadcast, 3d animation, computer graphics, pc game, console game, video game, cartoon, childish, watermark, logo, text, on screen text, subtitles, titles, signature, slowmo, static",
"enable_prompt_expansion": true,
"enable_safety_checker": true,
"video_output_type": "X264 (.mp4)",
"video_quality": "high",
"video_write_mode": "balanced",
"distill_lora_second_pass_scale": 0.5,
"video_strength": 1,
"audio_strength": 1,
"preprocessor": "none",
"ic_lora_type": "union"
}Output#
The generated video.
seed integer* requiredThe seed used for the random number generator.
prompt string* requiredThe prompt used for the generation.
{
"video": {
"width": 1888,
"height": 1056,
"num_frames": 161,
"url": "https://v3b.fal.media/files/b/0a9640bb/vqhmP1B5juujIXfBPTotm_5MBoh7yS.mp4",
"duration": 6.44,
"file_name": "vqhmP1B5juujIXfBPTotm_5MBoh7yS.mp4",
"fps": 25,
"content_type": "video/mp4"
},
"seed": 1490631192028410600,
"prompt": "black-and-white video, a cowboy walks through a dusty town, film grain"
}Other types#
VideoFile#
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
ImageSize#
width integerThe width of the generated image. Default value: 512
height integerThe height of the generated image. Default value: 512