Generate a video from a text prompt.
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("fal-ai/ltx-2.3-22b/text-to-video/lora", {
input: {
prompt: "A cowboy walking through a dusty town at high noon, camera following from behind, cinematic depth, realistic lighting, western mood, 4K film grain.",
loras: [{
path: "",
scale: 1
}]
},
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("fal-ai/ltx-2.3-22b/text-to-video/lora", {
input: {
prompt: "A cowboy walking through a dusty town at high noon, camera following from behind, cinematic depth, realistic lighting, western mood, 4K film grain.",
loras: [{
path: "",
scale: 1
}]
},
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("fal-ai/ltx-2.3-22b/text-to-video/lora", {
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("fal-ai/ltx-2.3-22b/text-to-video/lora", {
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 prompt to generate the video from.
num_frames integerThe number of frames to generate. Default value: 121
The size of the generated video. Default value: landscape_16_9
Possible enum values: 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
fps floatThe frames per second of the generated video. Default value: 24
num_inference_steps integerThe number of inference steps to use. Default value: 40
video_cfg_scale floatThe Classifier-Free Guidance (CFG) scale for the video. Higher values result in more consistent and focused video content. Default value: 3
video_stg_scale floatThe Spatiotemporal Guidance (STG) scale for the video. Higher values result in more consistent and focused video content.
video_rescaling_scale floatThe rescaling scale for the video. Controls the ratio between classifier-free guidance and spatiotemporal guidance. Default value: 0.7
video_modality_scale floatThe modality scale for the video. Controls the ratio between video and audio modalities. Default value: 3
audio_cfg_scale floatThe Classifier-Free Guidance (CFG) scale for the audio. Higher values result in more consistent and focused audio content. Default value: 7
audio_stg_scale floatThe Spatiotemporal Guidance (STG) scale for the audio. Higher values result in more consistent and focused audio content.
audio_rescaling_scale floatThe rescaling scale for the audio. Controls the ratio between classifier-free guidance and spatiotemporal guidance. Default value: 0.7
audio_modality_scale floatThe modality scale for the audio. Controls the ratio between video and audio modalities. Default value: 3
gradient_estimation_gamma floatThe gamma of gradient estimation during denoising. Set to 0 to disable. Default value: 2
use_restart_sampling booleanWhether to use restart sampling. This will inject a small amount of noise during each denoising step, which can help improve the quality of the generated video.
scheduler SchedulerEnumThe scheduler to use. Default value: "ltx2"
Possible enum values: ltx2, linear_quadratic, beta
acceleration AccelerationEnumThe acceleration level to use. Default value: "regular"
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.
The LoRAs to use for the generation.
distill_lora_first_pass_scale floatThe scale of the distill LoRA to use for the first pass. Set to 0 to disable. Default value: 0.2
distill_lora_second_pass_scale floatThe scale of the distill LoRA to use for the second and subsequent passes. Default value: 0.5
{
"prompt": "A cowboy walking through a dusty town at high noon, camera following from behind, cinematic depth, realistic lighting, western mood, 4K film grain.",
"num_frames": 121,
"video_size": "landscape_16_9",
"generate_audio": true,
"use_multiscale": true,
"fps": 24,
"num_inference_steps": 40,
"video_cfg_scale": 3,
"video_rescaling_scale": 0.7,
"video_modality_scale": 3,
"audio_cfg_scale": 7,
"audio_rescaling_scale": 0.7,
"audio_modality_scale": 3,
"gradient_estimation_gamma": 2,
"scheduler": "ltx2",
"acceleration": "regular",
"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",
"loras": [
{
"path": "",
"scale": 1
}
],
"distill_lora_first_pass_scale": 0.2,
"distill_lora_second_pass_scale": 0.5
}The generated video.
seed integer* requiredThe seed used for the random number generator.
prompt string* requiredThe prompt used for the generation.
{
"video": {
"duration": 6.44,
"file_name": "sdm0KfmenrlywesfzY1Y1_if6euPp1.mp4",
"height": 704,
"fps": 25,
"num_frames": 161,
"url": "https://v3b.fal.media/files/b/0a8824b1/sdm0KfmenrlywesfzY1Y1_if6euPp1.mp4",
"content_type": "video/mp4",
"width": 1248
},
"seed": 149063119,
"prompt": "A cowboy walking through a dusty town at high noon, camera following from behind, cinematic depth, realistic lighting, western mood, 4K film grain."
}path string* requiredURL, HuggingFace repo ID (owner/repo) to lora weights.
weight_name stringName of the LoRA weight. Only used if path is a HuggingFace repository, and is only required when the repository contains multiple LoRA weights.
scale floatScale factor for LoRA application (0.0 to 4.0). Default value: 1
width integerThe width of the generated image. Default value: 512
height integerThe height of the generated image. Default value: 512
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