Pro Image Edit
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/wan/v2.7/pro/edit", {
input: {
prompt: "Turn image 1 into a watercolor painting.",
image_urls: ["https://storage.googleapis.com/falserverless/model_tests/wan/dragon-warrior.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/wan/v2.7/pro/edit", {
input: {
prompt: "Turn image 1 into a watercolor painting.",
image_urls: ["https://storage.googleapis.com/falserverless/model_tests/wan/dragon-warrior.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/wan/v2.7/pro/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/wan/v2.7/pro/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* requiredText prompt describing the desired image edit. Supports Chinese and English.
Reference images for editing (1-4 images required). Order matters: reference them as image 1, image 2, image 3, image 4 in the prompt.
negative_prompt stringContent to avoid in the generated image. Max 500 characters. Default value: ""
Output image size. Uses fal image size presets or explicit dimensions and is converted to DashScope size format. Default value: square_hd
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_images integerNumber of images to generate (1-4). Default value: 1
enable_prompt_expansion booleanEnable DashScope prompt expansion. Supported only for image edit mode. Default value: true
seed integerRandom seed for reproducibility (0-2147483647).
enable_safety_checker booleanEnable content moderation for input and output. Disabling it requires account authorization; unauthorized requests are always checked. Default value: true
output_format OutputFormatEnumThe format of the generated images. Default value: "jpeg"
Possible enum values: jpeg, png, webp
{
"prompt": "Turn image 1 into a watercolor painting.",
"image_urls": [
"https://storage.googleapis.com/falserverless/model_tests/wan/dragon-warrior.jpg"
],
"image_size": "square_hd",
"num_images": 1,
"enable_prompt_expansion": true,
"enable_safety_checker": true,
"output_format": "jpeg"
}Generated images.
seed integer* requiredThe seed used for generation.
{
"images": [
{
"url": "",
"content_type": "image/png",
"file_name": "z9RV14K95DvU.png",
"file_size": 4404019
}
]
}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.