Loading API documentation
Edit Image
The client provides a convenient way to interact with the model API.
npm install --save @fal-ai/clientSet 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/hunyuan-image/v3/instruct/edit", {
input: {
prompt: "Turn this artwork into a realistic image",
image_urls: ["https://v3b.fal.media/files/b/0a8c3cf9/voXcX8hd5maRSrSvZalXh_jAMqrScj.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"
});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/hunyuan-image/v3/instruct/edit", {
input: {
prompt: "Turn this artwork into a realistic image",
image_urls: ["https://v3b.fal.media/files/b/0a8c3cf9/voXcX8hd5maRSrSvZalXh_jAMqrScj.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/hunyuan-image/v3/instruct/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/hunyuan-image/v3/instruct/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);Read more about file handling in our file upload guide.
prompt string* requiredThe text prompt to generate an image from.
The desired size of the generated image. If auto, image size will be determined by the model. Default value: auto
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
}num_images integerThe number of images to generate. Default value: 1
guidance_scale floatControls how much the model adheres to the prompt. Higher values mean stricter adherence. Default value: 3.5
enable_prompt_expansion booleanIf set to true, the prompt will be expanded through the model's internal recaptioning step. Default value: true
seed integerRandom seed for reproducible results. If None, a random seed is used.
enable_safety_checker booleanIf set to true, the safety checker will be enabled. Default value: true
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.
output_format OutputFormatEnumThe format of the generated image. Default value: "png"
Possible enum values: jpeg, png
The URLs of the images to use as a reference for the generation. A maximum of 3 images are supported.
{
"prompt": "Turn this artwork into a realistic image",
"image_size": "auto",
"num_images": 1,
"guidance_scale": 3.5,
"enable_prompt_expansion": true,
"enable_safety_checker": true,
"output_format": "png",
"image_urls": [
"https://v3b.fal.media/files/b/0a8c3cf9/voXcX8hd5maRSrSvZalXh_jAMqrScj.png"
]
}A list of the generated images.
seed integer* requiredThe base seed used for the generation process.
{
"images": [
{
"height": 1024,
"width": 1024,
"content_type": "image/png",
"url": "https://v3b.fal.media/files/b/0a8c3d5f/K7ecUzkFaxU-5hvzdhvG-_SOvArpR4.png"
}
]
}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 image in pixels.
height integerThe height of the image in pixels.