Generate video from an Ingredient reference sheet.
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-quality/ingredient", {
input: {
prompt: "Reference sheet: a chef in a white jacket, a copper pan, fresh basil, and a bright studio kitchen. Generated video: the chef tosses pasta in the copper pan, steam rising, cinematic food commercial.",
image_url: "https://storage.googleapis.com/falserverless/example_inputs/ltxv-2-i2v-input.jpg"
},
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-quality/ingredient", {
input: {
prompt: "Reference sheet: a chef in a white jacket, a copper pan, fresh basil, and a bright studio kitchen. Generated video: the chef tosses pasta in the copper pan, steam rising, cinematic food commercial.",
image_url: "https://storage.googleapis.com/falserverless/example_inputs/ltxv-2-i2v-input.jpg"
},
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-quality/ingredient", {
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-quality/ingredient", {
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 guide the generated video. For best results, use a 'Reference sheet: ... Generated video: ...' structure.
image_url string* requiredURL of the Ingredient reference sheet image. The sheet should contain clean panels for the characters, props, and location to preserve.
num_frames integerThe number of frames to generate. Default value: 121
The final generated video size. The default keeps the workflow's first stage at the Ingredient LoRA's trained 768x448 bucket before the official 2x refinement stage.
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
}frames_per_second floatFrames per second of the generated video. Default value: 24
guidance_scale floatClassifier-free guidance scale. Default value: 1
ingredient_strength floatStrength of the built-in Ingredient IC-LoRA. Higher values make the reference sheet identities and props more dominant. Default value: 1
reference_strength floatStrength of the reference-sheet guide. 1.0 uses the sheet fully; lower values give the model more freedom. Default value: 1
generate_audio booleanWhether to include audio in the returned video. When disabled, the final MP4 is returned without an audio track. Default value: true
negative_prompt stringThe negative prompt to steer generation away from. Default value: "worst quality, inconsistent motion, blurry, jittery, distorted"
seed integerRandom seed for reproducibility. If None, a random seed is chosen.
enable_prompt_expansion booleanWhether to enable prompt expansion. Default value: true
enable_safety_checker booleanWhether to enable the safety checker. Default value: true
video_quality VideoQualityEnumThe quality preset 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 is returned as a data URI inline in the response. Useful for short-lived requests and tests.
{
"prompt": "Reference sheet: a chef in a white jacket, a copper pan, fresh basil, and a bright studio kitchen. Generated video: the chef tosses pasta in the copper pan, steam rising, cinematic food commercial.",
"image_url": "https://storage.googleapis.com/falserverless/example_inputs/ltxv-2-i2v-input.jpg",
"num_frames": 121,
"resolution": {
"width": 1536,
"height": 896
},
"frames_per_second": 24,
"guidance_scale": 1,
"ingredient_strength": 1,
"reference_strength": 1,
"generate_audio": true,
"negative_prompt": "worst quality, inconsistent motion, blurry, jittery, distorted",
"enable_prompt_expansion": true,
"enable_safety_checker": true,
"video_quality": "high",
"video_write_mode": "balanced"
}The generated video.
seed integer* requiredThe seed actually used for generation.
prompt string* requiredThe prompt used for generation (after any expansion).
{
"video": {
"url": "",
"content_type": "image/png",
"file_name": "z9RV14K95DvU.png",
"file_size": 4404019
},
"prompt": ""
}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.