Replace backgrounds existing images with Ideogram V3's replace background feature. Create variations and adaptations while preserving core elements and adding new creative directions through prompt guidance.

fal-ai/ideogram/v3/replace-background

Inference

Commercial use

Partner

Schema

Playground API

fal-ai/ideogram/v3/replace-background

Schema

fal-ai/ideogram/v3/replace-background

Inference

Commercial use

Partner

Schema

Playground API

About

Ideogram V3 Replace Background

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. Install the new package and update your imports — see client setup.

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/v3/replace-background", {
  input: {
    prompt: "A beautiful sunset over mountains that writes Ideogram v3 in fal.ai",
    image_url: "https://v3.fal.media/files/rabbit/F6dvKPFL9VzKiM8asJOgm_MJj6yUB6rGjTsv_1YHIcA_image.webp"
  },
  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#

In an environment where you cannot set environment variables, you can configure the API key manually on the client.

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#

Long-running requests

For long-running requests, such as training jobs or models with slower inference times, it is recommended to check the Queue status and rely on Webhooks instead of blocking while waiting for the result.

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/v3/replace-background", {
  input: {
    prompt: "A beautiful sunset over mountains that writes Ideogram v3 in fal.ai",
    image_url: "https://v3.fal.media/files/rabbit/F6dvKPFL9VzKiM8asJOgm_MJj6yUB6rGjTsv_1YHIcA_image.webp"
  },
  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/v3/replace-background", {
  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/v3/replace-background", {
  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#

image_urls list<string>

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

color_palette ColorPalette

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)

style_codes list<string>

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.

Possible enum values: AUTO, GENERAL, REALISTIC, DESIGN

enable_prompt_expansion 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

sync_mode boolean

If True, the media will be returned as a data URI and the output data won't be available in the request history.

style_preset Enum

Style preset for generation. The chosen style preset will guide the generation.

Possible enum values: 80S_ILLUSTRATION, 90S_NOSTALGIA, ABSTRACT_ORGANIC, ANALOG_NOSTALGIA, ART_BRUT, ART_DECO, ART_POSTER, AURA, AVANT_GARDE, BAUHAUS, BLUEPRINT, BLURRY_MOTION, BRIGHT_ART, C4D_CARTOON, CHILDRENS_BOOK, COLLAGE, COLORING_BOOK_I, COLORING_BOOK_II, CUBISM, DARK_AURA, DOODLE, DOUBLE_EXPOSURE, DRAMATIC_CINEMA, EDITORIAL, EMOTIONAL_MINIMAL, ETHEREAL_PARTY, EXPIRED_FILM, FLAT_ART, FLAT_VECTOR, FOREST_REVERIE, GEO_MINIMALIST, GLASS_PRISM, GOLDEN_HOUR, GRAFFITI_I, GRAFFITI_II, HALFTONE_PRINT, HIGH_CONTRAST, HIPPIE_ERA, ICONIC, JAPANDI_FUSION, JAZZY, LONG_EXPOSURE, MAGAZINE_EDITORIAL, MINIMAL_ILLUSTRATION, MIXED_MEDIA, MONOCHROME, NIGHTLIFE, OIL_PAINTING, OLD_CARTOONS, PAINT_GESTURE, POP_ART, RETRO_ETCHING, RIVIERA_POP, SPOTLIGHT_80S, STYLIZED_RED, SURREAL_COLLAGE, TRAVEL_POSTER, VINTAGE_GEO, VINTAGE_POSTER, WATERCOLOR, WEIRD, WOODBLOCK_PRINT

prompt string* required

Cyber punk city with neon lights and skyscrappers

image_url string* required

The image URL whose background needs to be replaced

enable_safety_checker boolean

Authorized callers may set false to request relaxed screening. Default value: true

{
  "rendering_speed": "BALANCED",
  "enable_prompt_expansion": true,
  "num_images": 1,
  "prompt": "A beautiful sunset over mountains that writes Ideogram v3 in fal.ai",
  "image_url": "https://v3.fal.media/files/rabbit/F6dvKPFL9VzKiM8asJOgm_MJj6yUB6rGjTsv_1YHIcA_image.webp",
  "enable_safety_checker": true
}

Output#

images list<File>* required

seed integer* required

Seed used for the random number generator

{
  "images": [
    {
      "url": "https://v3.fal.media/files/lion/AUfCjtLkLOsdc9zEFrV-5_image.png"
    }
  ],
  "seed": 123456
}

Other types#

File#

url string* required

The 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#

members list<ColorPaletteMember>

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 RGBColor* required

RGB color value for the palette member

color_weight float

The weight of the color in the color palette Default value: 0.5

RGBColor#

r integer

Red color value

g integer

Green color value

b integer

Blue color value

Related Models

About

Ideogram V3 Replace Background

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. Install the new package and update your imports — see client setup.

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/v3/replace-background", {
  input: {
    prompt: "A beautiful sunset over mountains that writes Ideogram v3 in fal.ai",
    image_url: "https://v3.fal.media/files/rabbit/F6dvKPFL9VzKiM8asJOgm_MJj6yUB6rGjTsv_1YHIcA_image.webp"
  },
  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#

In an environment where you cannot set environment variables, you can configure the API key manually on the client.

import { fal } from "@fal-ai/client";

fal.config({
  credentials: "YOUR_FAL_KEY"
});

Protect your API Key

3. Queue#

Long-running requests

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/v3/replace-background", {
  input: {
    prompt: "A beautiful sunset over mountains that writes Ideogram v3 in fal.ai",
    image_url: "https://v3.fal.media/files/rabbit/F6dvKPFL9VzKiM8asJOgm_MJj6yUB6rGjTsv_1YHIcA_image.webp"
  },
  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/v3/replace-background", {
  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/v3/replace-background", {
  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)#

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#

image_urls list<string>

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

color_palette ColorPalette

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)

style_codes list<string>

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.

Possible enum values: AUTO, GENERAL, REALISTIC, DESIGN

enable_prompt_expansion 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

sync_mode boolean

If True, the media will be returned as a data URI and the output data won't be available in the request history.

style_preset Enum

Style preset for generation. The chosen style preset will guide the generation.

prompt string* required

Cyber punk city with neon lights and skyscrappers

image_url string* required

The image URL whose background needs to be replaced

enable_safety_checker boolean

Authorized callers may set false to request relaxed screening. Default value: true

{
  "rendering_speed": "BALANCED",
  "enable_prompt_expansion": true,
  "num_images": 1,
  "prompt": "A beautiful sunset over mountains that writes Ideogram v3 in fal.ai",
  "image_url": "https://v3.fal.media/files/rabbit/F6dvKPFL9VzKiM8asJOgm_MJj6yUB6rGjTsv_1YHIcA_image.webp",
  "enable_safety_checker": true
}

Output#

images list<File>* required

seed integer* required

Seed used for the random number generator

{
  "images": [
    {
      "url": "https://v3.fal.media/files/lion/AUfCjtLkLOsdc9zEFrV-5_image.png"
    }
  ],
  "seed": 123456
}

Other types#

File#

url string* required

The 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#

members list<ColorPaletteMember>

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 RGBColor* required

RGB color value for the palette member

color_weight float

The weight of the color in the color palette Default value: 0.5

RGBColor#

r integer

Red color value

g integer

Green color value

b integer

Blue color value

Related Models

Ideogram Replace Background Image to Image API Docs | fal

fal-ai/ideogram/v3/replace-background

Table of contents

Table of contents

fal-ai/ideogram/v3/replace-background

About

1. Calling the API#

Install the client#

Migrate to @fal-ai/client

Setup your API Key#

Submit a request#

2. Authentication#

API Key#

Protect your API Key

3. Queue#

Long-running requests

Submit a request#

Fetch request status#

Get the result#

4. Files#

Data URI (base64)#

Hosted files (URL)#

Uploading files#

Auto uploads

5. Schema#

Input#

Output#

Other types#

File#

ColorPalette#

ColorPaletteMember#

RGBColor#

Related Models

Table of contents

About

1. Calling the API#

Install the client#

Migrate to @fal-ai/client

Setup your API Key#

Submit a request#

2. Authentication#

API Key#

Protect your API Key

3. Queue#

Long-running requests

Submit a request#

Fetch request status#

Get the result#

4. Files#

Data URI (base64)#

Hosted files (URL)#

Uploading files#

Auto uploads

5. Schema#

Input#

Output#

Other types#

File#

ColorPalette#

ColorPaletteMember#

RGBColor#

Related Models