Loading API documentation
Edit images using FireRed-Image-Edit, a high-fidelity instruction-based image editing model.
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/firered-image-edit", {
input: {
prompt: "Move the whirling dervishes to this colorful room",
image_urls: ["https://v3b.fal.media/files/b/0a8ed7f7/ElaLDgkUJiEazYH90eqJ3.jpg", "https://v3b.fal.media/files/b/0a8ed7f9/4keTvi5q_yV4pCIUzAyFR.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/firered-image-edit", {
input: {
prompt: "Move the whirling dervishes to this colorful room",
image_urls: ["https://v3b.fal.media/files/b/0a8ed7f7/ElaLDgkUJiEazYH90eqJ3.jpg", "https://v3b.fal.media/files/b/0a8ed7f9/4keTvi5q_yV4pCIUzAyFR.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/firered-image-edit", {
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/firered-image-edit", {
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 editing instruction describing what changes to make to the image. Supports both English and Chinese instructions.
The size of the generated image. If None, uses the input image dimensions.
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. More steps generally produce higher quality results. Default value: 30
seed integerThe same seed and the same prompt given to the same version of the model will output the same image every time.
guidance_scale floatClassifier-free guidance scale. Higher values make the model follow the prompt more closely. Default value: 4
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
enable_safety_checker booleanIf set to true, the safety checker will be enabled. Disabling it requires account authorization; unauthorized requests are always checked, and images flagged as unsafe are returned as black images. Default value: true
output_format OutputFormatEnumThe format of the generated image. Default value: "png"
Possible enum values: jpeg, png
The URLs of the images to edit. Supports single image editing and multi-image references (e.g., virtual try-on, style transfer from reference).
negative_prompt stringThe negative prompt for the generation. Default value: ""
acceleration AccelerationEnumThe acceleration level to use for inference speed optimization. Default value: "regular"
Possible enum values: none, regular, high
{
"prompt": "Move the whirling dervishes to this colorful room",
"image_size": {
"width": 1536,
"height": 768
},
"num_inference_steps": 30,
"guidance_scale": 4,
"num_images": 1,
"enable_safety_checker": true,
"output_format": "png",
"image_urls": [
"https://v3b.fal.media/files/b/0a8ed7f7/ElaLDgkUJiEazYH90eqJ3.jpg",
"https://v3b.fal.media/files/b/0a8ed7f9/4keTvi5q_yV4pCIUzAyFR.jpg"
],
"acceleration": "regular"
}The edited 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": [
{
"content_type": "image/jpeg",
"width": 1376,
"url": "https://v3b.fal.media/files/b/0a8ed7fa/pHsp1KWzqkNNYfAcZ_bkY.jpg",
"height": 768
}
],
"prompt": ""
}width integerThe width of the generated image. Default value: 512
height integerThe height of the generated image. Default value: 512
url string* requiredwidth integer* requiredheight integer* requiredcontent_type stringDefault value: "image/jpeg"