Generate
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/chrono-edit-lora", {
input: {
image_url: "https://v3b.fal.media/files/b/zebra/yRvp9rTyDeDGHnbmtcsgK_original-wave.jpg",
prompt: "Add a surfer to the wave in the illustration."
},
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/chrono-edit-lora", {
input: {
image_url: "https://v3b.fal.media/files/b/zebra/yRvp9rTyDeDGHnbmtcsgK_original-wave.jpg",
prompt: "Add a surfer to the wave in the illustration."
},
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/chrono-edit-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/chrono-edit-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.
image_url string* requiredThe image to edit.
prompt string* requiredThe prompt to edit the image.
num_inference_steps integerThe number of inference steps to perform. Default value: 8
guidance_scale floatThe guidance scale for the inference. Default value: 1
enable_prompt_expansion booleanWhether to enable prompt expansion. Default value: true
enable_temporal_reasoning booleanWhether to enable temporal reasoning.
num_temporal_reasoning_steps integerThe number of temporal reasoning steps to perform. Default value: 8
resolution ResolutionEnumThe resolution of the output image. Default value: "480p"
Possible enum values: 480p, 720p
enable_safety_checker booleanWhether to enable the safety checker. Disabling it requires account authorization; unauthorized requests are always checked. Default value: true
seed integerThe seed for the inference.
output_format OutputFormatEnumThe format of the output image. Default value: "jpeg"
Possible enum values: jpeg, png, webp
sync_mode booleanWhether to return the image in sync mode.
turbo_mode booleanEnable turbo mode to use for faster inference. Default value: true
Optional additional LoRAs to merge for this request (max 3).
{
"image_url": "https://v3b.fal.media/files/b/zebra/yRvp9rTyDeDGHnbmtcsgK_original-wave.jpg",
"prompt": "Add a surfer to the wave in the illustration.",
"num_inference_steps": 8,
"guidance_scale": 1,
"enable_prompt_expansion": true,
"num_temporal_reasoning_steps": 8,
"resolution": "480p",
"enable_safety_checker": true,
"output_format": "jpeg",
"turbo_mode": true,
"loras": []
}The edited image.
prompt string* requiredThe prompt used for the inference.
seed integer* requiredThe seed for the inference.
{
"images": [
{
"file_name": "2_gRhwfsnmNKYtZ_dveyV.jpg",
"url": "https://v3b.fal.media/files/b/koala/2_gRhwfsnmNKYtZ_dveyV.jpg",
"width": 1152,
"height": 768,
"content_type": "image/jpeg"
}
],
"prompt": "The user wants to add a surfer to the wave in the illustration while preserving the original ukiyo-e woodblock art style. The surfer should be depicted mid-action, crouched low on a modern-style surfboard, carving through the crest of the wave with one arm extended for balance and the other gripping the board. Their wavy hair and athletic physique should match the dynamic motion. The background must remain unchanged, including the iconic Mount Fuji and the traditional Japanese text, to maintain the artwork's historical aesthetic and composition."
}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 image
height integerThe height of the image
path string* requiredURL or path to the LoRA weights (Safetensors).
scale floatScale factor controlling LoRA strength. Default value: 1