🎉 New Models Available: grok-4 now live!
→ Explore New Features

Replace Background 3.0（Background replacement）

Testing

POST

https://api.cometapi.com/ideogram/v1/ideogram-v3/replace-background

Maintainer:Not configured

Use Ideogram 3.0's prompts to synchronize the replacement of the background of a given image. The foreground subject will be recognized and retained, while the background will be replaced according to the prompt and the selected style. Supported image formats include JPEG, PNG, and WebP. The image link is available for a limited time; if you want to keep the image, you must download it.
See the official documentation for specific parameters: https://developer.ideogram.ai/api-reference/api-reference/replace-background-v3
The returned image URL is valid for 24 hours, after which the image will not be accessible.

Request

Header Params

Authorization

string

optional

Example:

string

optional

Example:

application/json

Content-Type

string

optional

Example:

application/json

Body Params multipart/form-data

image

file

required

prompt

string

required

rendering_speed

string

optional

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.cometapi.com/ideogram/v1/ideogram-v3/replace-background' \
--header 'Authorization: {{api-key}}' \
--header 'Accept: application/json' \
--form 'image=@""' \
--form 'prompt=""' \
--form 'rendering_speed=""'

Responses

🟢200OK

application/json

success

Body

created

string

required

data

array [object {6}]

required

prompt

string

optional

resolution

string

optional

is_image_safe

boolean

optional

seed

integer

optional

url

string

optional

style_type

string

optional

Example

{
    "created": "2000-01-23 04:56:07+00:00",
    "data": [
        {
            "prompt": "Add a forest in the background",
            "resolution": "1280x800",
            "is_image_safe": true,
            "seed": 12345,
            "url": "https://ideogram.ai/api/images/ephemeral/xtdZiqPwRxqY1Y7NExFmzB.png?exp=1743867804&sig=e13e12677633f646d8531a153d20e2d3698dca9ee7661ee5ba4f3b64e7ec3f89",
            "style_type": "GENERAL"
        }
    ]
}

Reframe 3.0（Reconstruction）

Edit 3.0（Editing images）