Ideogram V45 Edit
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("ideogram/v4.5/edit", {
input: {
prompt: "A colorful storefront with a sign reading hello",
image_url: ""
},
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("ideogram/v4.5/edit", {
input: {
prompt: "A colorful storefront with a sign reading hello",
image_url: ""
},
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("ideogram/v4.5/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("ideogram/v4.5/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 generation or editing prompt.
image_url string* requiredPrimary source image to edit.
Up to four references plus the primary source, or three references plus the primary source and mask.
mask_url stringMask matching the source dimensions. Black edits, white preserves. Must contain both regions after rounding.
edit_precision EditPrecisionEnumregular uses Generate; high uses Precise Edit with unchanged-pixel restoration. Both always prepare structured edit instructions. Default value: "regular"
Possible enum values: regular, high
context_window ContextWindowEnumRegion to edit with high edit_precision. none edits the whole image, downscaled to at most 4194304 pixels. auto requires mask_url and fits the region around the mask; an oversized mask falls back to whole-image editing. Set context_window_box instead to pick the region yourself. Localized edits preserve the original image resolution and every pixel outside the region. Default value: "none"
Possible enum values: none, auto
Explicit region to edit with high edit_precision, in source pixels with exclusive x_max/y_max. Must lie inside the image, measure at least 256 pixels per side, cover at most 4194304 pixels, and have an aspect ratio within 1:6 and 6:1. A mask may select only pixels inside it. Cannot be combined with context_window auto. Leave unset to edit the whole image.
quality QualityEnumQuality tier for either edit precision. Defaults to medium. Default value: "medium"
Possible enum values: very_low, low, medium, high
auto preserves source geometry, downscaled by the provider if needed. Only unmasked regular edits accept named presets or custom sizes: dimensions >=256, multiples of 32, area <=4194304, ratio <=6:1. Named presets use standard fal dimensions. Default value: auto
Possible enum values: auto, square, square_hd, portrait_4_3, landscape_4_3, portrait_16_9, 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. Default value: 1
seed integerRandom seed. Omit to choose automatically.
sync_mode booleanReturn image data directly in the response.
enable_safety_checker booleanAuthorized callers may set false to request relaxed screening. Default value: true
{
"prompt": "A colorful storefront with a sign reading hello",
"image_url": "",
"edit_precision": "regular",
"context_window": "none",
"quality": "medium",
"image_size": "auto",
"num_images": 1,
"enable_safety_checker": true
}seed integer* requiredSeed used for the random number generator
{
"images": [
{
"url": "https://v3.fal.media/files/penguin/lHdRabS80guysb8Zw1kul_image.png"
}
],
"seed": 123456
}x_min integer* requiredLeft edge in source pixels (inclusive).
y_min integer* requiredTop edge in source pixels (inclusive).
x_max integer* requiredRight edge in source pixels (exclusive).
y_max integer* requiredBottom edge in source pixels (exclusive).
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.