Loading API documentation
Inference
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/iclight-v2", {
input: {
prompt: "perfume bottle in a volcano surrounded by lava.",
image_url: "https://storage.googleapis.com/falserverless/iclight-v2/bottle.png"
},
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/iclight-v2", {
input: {
prompt: "perfume bottle in a volcano surrounded by lava.",
image_url: "https://storage.googleapis.com/falserverless/iclight-v2/bottle.png"
},
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/iclight-v2", {
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/iclight-v2", {
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 an image from.
negative_prompt stringNegative Prompt for the image Default value: ""
image_url string* requiredURL of image to be used for relighting
mask_image_url stringURL of mask to be used for ic-light conditioning image
background_threshold floatThreshold for the background removal algorithm. A high threshold will produce sharper masks. Note: This parameter is currently deprecated and has no effect on the output. Default value: 0.67
The size of the generated image.
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
}num_inference_steps integerThe number of inference steps to perform. Default value: 28
seed integerThe same seed and the same prompt given to the same version of the model will output the same image every time.
initial_latent InitialLatentEnumProvide lighting conditions for the model Default value: "None"
Possible enum values: None, Left, Right, Top, Bottom
enable_hr_fix booleanUse HR fix
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.
num_images integerThe number of images to generate. Default value: 1
cfg floatThe real classifier-free-guidance scale for the generation. Default value: 1
lowres_denoise floatStrength for low-resolution pass. Default value: 0.98
highres_denoise floatStrength for high-resolution pass. Only used if enable_hr_fix is True. Default value: 0.95
hr_downscale floatDefault value: 0.5
guidance_scale floatThe CFG (Classifier Free Guidance) scale is a measure of how close you want
the model to stick to your prompt when looking for a related image to show you. Default value: 5
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
output_format OutputFormatEnumThe format of the generated image. Default value: "jpeg"
Possible enum values: jpeg, png
{
"prompt": "perfume bottle in a volcano surrounded by lava.",
"image_url": "https://storage.googleapis.com/falserverless/iclight-v2/bottle.png",
"background_threshold": 0.67,
"num_inference_steps": 28,
"initial_latent": "None",
"num_images": 1,
"cfg": 1,
"lowres_denoise": 0.98,
"highres_denoise": 0.95,
"hr_downscale": 0.5,
"guidance_scale": 5,
"enable_safety_checker": true,
"output_format": "jpeg"
}The generated image files info.
seed integer* requiredSeed of the generated Image. It will be the same value of the one passed in the input or the randomly generated that was used in case none was passed.
Whether the generated images contain NSFW concepts.
prompt string* requiredThe prompt used for generating the image.
{
"images": [
{
"url": "",
"content_type": "image/jpeg"
}
],
"prompt": ""
}url string* requiredwidth integer* requiredheight integer* requiredcontent_type stringDefault value: "image/jpeg"
width integerThe width of the generated image. Default value: 512
height integerThe height of the generated image. Default value: 512