Loading API documentation
Generate Image To Image
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/glm-image/image-to-image", {
input: {
prompt: "Make the dress red.",
image_urls: "https://storage.googleapis.com/falserverless/example_inputs/catwalk.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/glm-image/image-to-image", {
input: {
prompt: "Make the dress red.",
image_urls: "https://storage.googleapis.com/falserverless/example_inputs/catwalk.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/glm-image/image-to-image", {
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/glm-image/image-to-image", {
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 for image generation.
Output image size. Default value: square_hd
Possible enum values: square_hd, square, portrait_4_3, portrait_16_9, landscape_4_3, landscape_16_9, portrait_3_2, landscape_3_2, portrait_hd, landscape_hd
Note: For custom image sizes, you can pass the width and height as an object:
"image_size": {
"width": 1280,
"height": 720
}num_inference_steps integerNumber of diffusion denoising steps. More steps generally produce higher quality images. Default value: 30
guidance_scale floatClassifier-free guidance scale. Higher values make the model follow the prompt more closely. Default value: 1.5
seed integerRandom seed for reproducibility. The same seed with the same prompt will produce the same image.
num_images integerNumber of images to generate. Default value: 1
enable_safety_checker booleanEnable NSFW safety checking on the generated images. 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 OutputFormatEnumOutput image format. Default value: "jpeg"
Possible enum values: jpeg, png
sync_mode booleanIf True, the image will be returned as a base64 data URI instead of a URL.
enable_prompt_expansion booleanIf True, the prompt will be enhanced using an LLM for more detailed and higher quality results.
URL(s) of the condition image(s) for image-to-image generation. Supports up to 4 URLs for multi-image references.
{
"prompt": "Make the dress red.",
"image_size": "square_hd",
"num_inference_steps": 30,
"guidance_scale": 1.5,
"num_images": 1,
"enable_safety_checker": true,
"output_format": "jpeg",
"image_urls": "https://storage.googleapis.com/falserverless/example_inputs/catwalk.png"
}List of URLs to the generated images.
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": [
{
"width": 1024,
"content_type": "image/png",
"height": 1536,
"url": "https://storage.googleapis.com/falserverless/example_outputs/catwalk_red.png"
}
],
"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