Replace Background 3.0

Testing

POST

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

Synchronously replaces the background of a given image using Ideogram 3.0 prompts. The foreground subject will be identified and retained, while the background will be replaced based on the prompt and 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.

For specific parameters, see the official documentation: 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 be inaccessible.

Request

Header Params

Body Params multipart/form-data

Responses

🟢200OK

application/json

Successfully described the image

Body

Request Example

Shell

JavaScript

Java

Swift

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

Response 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 (Refactoring)

Remix 3.0 (Mixed Graph)