Ideogram V2 Edit Image to Image
About
Ideogram's state-of-the-art image editing model. Can be used as an API directly from fal.
1. Calling the API#
Install the client#
The client provides a convenient way to interact with the model API.
npm install --save @fal-ai/client
Migrate to @fal-ai/client
The @fal-ai/serverless-client
package has been deprecated in favor of @fal-ai/client
. Please check the migration guide for more information.
Setup your API Key#
Set FAL_KEY
as an environment variable in your runtime.
export FAL_KEY="YOUR_API_KEY"
Submit a request#
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/ideogram/v2/edit", {
input: {
prompt: "A knight in shining armour holding a greatshield with \"FAL\" on it",
image_url: "https://storage.googleapis.com/falserverless/flux-lora/example-images/knight.jpeg",
mask_url: "https://storage.googleapis.com/falserverless/flux-lora/example-images/mask_knight.jpeg"
},
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);
2. Authentication#
The API uses an API Key for authentication. It is recommended you set the FAL_KEY
environment variable in your runtime when possible.
API Key#
import { fal } from "@fal-ai/client";
fal.config({
credentials: "YOUR_FAL_KEY"
});
Protect your API 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.
3. Queue#
Submit a request#
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/ideogram/v2/edit", {
input: {
prompt: "A knight in shining armour holding a greatshield with \"FAL\" on it",
image_url: "https://storage.googleapis.com/falserverless/flux-lora/example-images/knight.jpeg",
mask_url: "https://storage.googleapis.com/falserverless/flux-lora/example-images/mask_knight.jpeg"
},
webhookUrl: "https://optional.webhook.url/for/results",
});
Fetch request status#
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/ideogram/v2/edit", {
requestId: "764cabcf-b745-4b3e-ae38-1200304cf45b",
logs: true,
});
Get the result#
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/ideogram/v2/edit", {
requestId: "764cabcf-b745-4b3e-ae38-1200304cf45b"
});
console.log(result.data);
console.log(result.requestId);
4. Files#
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.
Data URI (base64)#
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.
Hosted files (URL)#
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.
Uploading files#
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);
Auto uploads
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.
5. Schema#
Input#
prompt
string
* requiredThe prompt to fill the masked part of the image.
image_url
string
* requiredThe image URL to generate an image from. Needs to match the dimensions of the mask.
mask_url
string
* requiredThe mask URL to inpaint the image. Needs to match the dimensions of the input image.
seed
integer
Seed for the random number generator
style
StyleEnum
The style of the generated image Default value: "auto"
Possible enum values: auto, general, realistic, design, render_3D, anime
expand_prompt
boolean
Whether to expand the prompt with MagicPrompt functionality. Default value: true
{
"prompt": "A knight in shining armour holding a greatshield with \"FAL\" on it",
"image_url": "https://storage.googleapis.com/falserverless/flux-lora/example-images/knight.jpeg",
"mask_url": "https://storage.googleapis.com/falserverless/flux-lora/example-images/mask_knight.jpeg",
"style": "auto",
"expand_prompt": true
}
Output#
seed
integer
* requiredSeed used for the random number generator
{
"images": [
{
"url": "https://fal.media/files/monkey/cNaoxPl0YAWYb-QVBvO9F_image.png"
}
],
"seed": 123456
}
Other types#
ReplaceBackgroundInputV3#
A set of images to use as style references (maximum total size 10MB across all style references). The images should be in JPEG, PNG or WebP format
rendering_speed
RenderingSpeedEnum
The rendering speed to use. Default value: "BALANCED"
Possible enum values: TURBO, BALANCED, QUALITY
A color palette for generation, must EITHER be specified via one of the presets (name) or explicitly via hexadecimal representations of the color with optional weights (members)
A list of 8 character hexadecimal codes representing the style of the image. Cannot be used in conjunction with style_reference_images or style
style
Enum
The style type to generate with. Cannot be used with style_codes. Default value: AUTO
Possible enum values: AUTO, GENERAL, REALISTIC, DESIGN
expand_prompt
boolean
Determine if MagicPrompt should be used in generating the request or not. Default value: true
num_images
integer
Number of images to generate. Default value: 1
seed
integer
Seed for the random number generator
prompt
string
* requiredCyber punk city with neon lights and skyscrappers
image_url
string
* requiredThe image URL whose background needs to be replaced
BaseTextToImageInputV3#
A set of images to use as style references (maximum total size 10MB across all style references). The images should be in JPEG, PNG or WebP format
rendering_speed
RenderingSpeedEnum
The rendering speed to use. Default value: "BALANCED"
Possible enum values: TURBO, BALANCED, QUALITY
A color palette for generation, must EITHER be specified via one of the presets (name) or explicitly via hexadecimal representations of the color with optional weights (members)
A list of 8 character hexadecimal codes representing the style of the image. Cannot be used in conjunction with style_reference_images or style
style
Enum
The style type to generate with. Cannot be used with style_codes. Default value: AUTO
Possible enum values: AUTO, GENERAL, REALISTIC, DESIGN
expand_prompt
boolean
Determine if MagicPrompt should be used in generating the request or not. Default value: true
num_images
integer
Number of images to generate. Default value: 1
seed
integer
Seed for the random number generator
prompt
string
* requiredThe resolution of the generated image 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
}
negative_prompt
string
Description of what to exclude from an image. Descriptions in the prompt take precedence to descriptions in the negative prompt. Default value: ""
RGBColor#
r
integer
* requiredRed color value
g
integer
* requiredGreen color value
b
integer
* requiredBlue color value
File#
url
string
* requiredThe URL where the file can be downloaded from.
content_type
string
The mime type of the file.
file_name
string
The name of the file. It will be auto-generated if not provided.
file_size
integer
The size of the file in bytes.
ColorPalette#
A list of color palette members that define the color palette
name
Enum
A color palette preset value
Possible enum values: EMBER, FRESH, JUNGLE, MAGIC, MELON, MOSAIC, PASTEL, ULTRAMARINE
ColorPaletteMember#
RGB color value for the palette member
color_weight
float
The weight of the color in the color palette Default value: 0.5
ImageSize#
width
integer
The width of the generated image. Default value: 512
height
integer
The height of the generated image. Default value: 512
RemixImageInputV3#
A set of images to use as style references (maximum total size 10MB across all style references). The images should be in JPEG, PNG or WebP format
rendering_speed
RenderingSpeedEnum
The rendering speed to use. Default value: "BALANCED"
Possible enum values: TURBO, BALANCED, QUALITY
A color palette for generation, must EITHER be specified via one of the presets (name) or explicitly via hexadecimal representations of the color with optional weights (members)
A list of 8 character hexadecimal codes representing the style of the image. Cannot be used in conjunction with style_reference_images or style
style
Enum
The style type to generate with. Cannot be used with style_codes. Default value: AUTO
Possible enum values: AUTO, GENERAL, REALISTIC, DESIGN
expand_prompt
boolean
Determine if MagicPrompt should be used in generating the request or not. Default value: true
num_images
integer
Number of images to generate. Default value: 1
seed
integer
Seed for the random number generator
prompt
string
* requiredThe prompt to remix the image with
image_url
string
* requiredThe image URL to remix
strength
float
Strength of the input image in the remix Default value: 0.8
The resolution of the generated image 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
}
negative_prompt
string
Description of what to exclude from an image. Descriptions in the prompt take precedence to descriptions in the negative prompt. Default value: ""
EditImageInputV3#
A set of images to use as style references (maximum total size 10MB across all style references). The images should be in JPEG, PNG or WebP format
rendering_speed
RenderingSpeedEnum
The rendering speed to use. Default value: "BALANCED"
Possible enum values: TURBO, BALANCED, QUALITY
A color palette for generation, must EITHER be specified via one of the presets (name) or explicitly via hexadecimal representations of the color with optional weights (members)
A list of 8 character hexadecimal codes representing the style of the image. Cannot be used in conjunction with style_reference_images or style
expand_prompt
boolean
Determine if MagicPrompt should be used in generating the request or not. Default value: true
num_images
integer
Number of images to generate. Default value: 1
seed
integer
Seed for the random number generator
prompt
string
* requiredThe prompt to fill the masked part of the image.
image_url
string
* requiredThe image URL to generate an image from. Needs to match the dimensions of the mask.
mask_url
string
* requiredThe mask URL to inpaint the image. Needs to match the dimensions of the input image.
ReframeImageInputV3#
A set of images to use as style references (maximum total size 10MB across all style references). The images should be in JPEG, PNG or WebP format
rendering_speed
RenderingSpeedEnum
The rendering speed to use. Default value: "BALANCED"
Possible enum values: TURBO, BALANCED, QUALITY
A color palette for generation, must EITHER be specified via one of the presets (name) or explicitly via hexadecimal representations of the color with optional weights (members)
A list of 8 character hexadecimal codes representing the style of the image. Cannot be used in conjunction with style_reference_images or style
style
Enum
The style type to generate with. Cannot be used with style_codes. Default value: AUTO
Possible enum values: AUTO, GENERAL, REALISTIC, DESIGN
num_images
integer
Number of images to generate. Default value: 1
seed
integer
Seed for the random number generator
image_url
string
* requiredThe image URL to reframe
The resolution for the reframed output image
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
}