Edit 3.0（Editing images）

Testing

POST

https://api.cometapi.com/ideogram/v1/ideogram-v3/edit

Maintainer:Not configured

Synchronize the editing of a given image using the provided masks and Ideogram 3.0. The mask indicates which part of the image should be edited, while hints and selected styles can further guide the editing.
See official documentation for specific parameters: https://developer.ideogram.ai/api-reference/api-reference/edit-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

prompt

string

required

Describe how to edit text in an image

Example:

cat

rendering_speed

string

optional

image

file

required

mask

file

required

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/edit' \
--header 'Authorization: {{api-key}}' \
--header 'Accept: application/json' \
--form 'prompt="cat"' \
--form 'rendering_speed=""' \
--form 'image=@""' \
--form 'mask=@""'

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": "A photo of a cat wearing a hat.",
            "resolution": "1024x1024",
            "is_image_safe": true,
            "seed": 12345,
            "url": "https://ideogram.ai/api/images/ephemeral/xtdZiqPwRxqY1Y7NExFmzB.png?exp=1743867804&sig=e13e12677633f646d8531a153d20e2d3698dca9ee7661ee5ba4f3b64e7ec3f89",
            "style_type": "GENERAL"
        }
    ]
}

🟠400Bad Request

Replace Background 3.0（Background replacement）

ideogram Text Raw Image