ideogram Edit image - API Doc-CometAPI

Request

Header Params

Authorization

string

optional

Example:

Body Params multipart/form-data

image_file

file

required

An image binary; only JPEG, WEBPs and PNGs are supported at this time

mask

file

required

file:///Users/zcz/Pictures/ (1).png

prompt

string

required

Example:

cat

model

string

optional

Example:

V_2_TURBO

magic_prompt_option

enum<string>

optional

AUTO,ON,OFF

Allowed values:

AUTOONOFF

Default:

AUTO

seed

string

optional

style_type

enum<string>

optional

Generated style type; this applies only to Model V_2 and higher and should not be specified for Model Version V_1.

Allowed values:

AUTOGENERALREALISTICDESIGNRENDER_3DANIME

num_images

string

optional

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://api.cometapi.com/edit' \
--header 'Authorization: {{api-key}}' \
--form 'image_file=@""' \
--form 'mask=@""' \
--form 'prompt="cat"' \
--form 'model="V_2_TURBO"' \
--form 'magic_prompt_option=""' \
--form 'seed=""' \
--form 'style_type=""' \
--form 'num_images=""'

Responses

🟢200OK

application/json

success

Body

data

array [object {5}]

required

A list of ImageObjects that contain the generated image(s).

seed

integer

optional

0 to 2147483647

prompt

string

required

The prompt used for the generation. This may be different from the original prompt.

resolution

string

optional

The resolution of the final image.

url

string

required

The direct link to the image generated.

is_image_safe

boolean

required

Whether this request passes safety checks. If false, the url field will be empty.

created

string

required

The time the request was created.

Example

{
    "data": [
        {
            "seed": 12345,
            "prompt": "A serene tropical beach scene. Dominating the foreground are tall palm trees with lush green leaves, standing tall against a backdrop of a sandy beach. The beach leads to the azure waters of the sea, which gently kisses the shoreline. In the distance, there's an island or landmass with a silhouette of what appears to be a lighthouse or tower. The sky above is painted with fluffy white clouds, some of which are tinged with hues of pink and orange, suggesting either a sunrise or sunset.",
            "resolution": "1024x1024",
            "url": "https://ideogram.ai/api/images/direct/8YEpFzHuS-S6xXEGmCsf7g",
            "is_image_safe": true
        },
        {
            "seed": 12345,
            "prompt": "A serene tropical beach scene. Dominating the foreground are tall palm trees with lush green leaves, standing tall against a backdrop of a sandy beach. The beach leads to the azure waters of the sea, which gently kisses the shoreline. In the distance, there's an island or landmass with a silhouette of what appears to be a lighthouse or tower. The sky above is painted with fluffy white clouds, some of which are tinged with hues of pink and orange, suggesting either a sunrise or sunset.",
            "resolution": "1024x1024",
            "url": "https://ideogram.ai/api/images/direct/8YEpFzHuS-S6xXEGmCsf7g",
            "is_image_safe": true
        }
    ],
    "created": "2000-01-23T04:56:07.000Z"
}

🟠400Bad Request