Edit - API reference

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Header Params

Api-Key

string

optional

Example:

kVSFo8SxtgB8salBMacNeHZtGe9pxL-i5vFFnSyA1n9cM7L8UFBsHWEFHYdG8BwSBmXef8HqdEPwjThEwFvl1g

Authorization

string

optional

Default:

Body Params multipart/form-data

image_file

file

required

An image binary; only JPEG, WEBPs and PNGs are supported at this time
图像二进制；目前仅支持 JPEG、WEBP 和 PNG 格式

Example:

file:///Users/zcz/Pictures/下载.png

mask

file

required

Example:

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

prompt

string

required

Example:

cat

model

string

required

Example:

V_2_TURBO

magic_prompt_option

string

optional

Default:

AUTO

Examples:

AUTOONOFF

seed

integer

optional

style_type

string

optional

生成的样式类型；这仅适用于型号 V_2 及更高版本，不应为型号版本 V_1 指定。

Examples:

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 -g --request POST '/ideogram/edit' \
--header 'Api-Key: kVSFo8SxtgB8salBMacNeHZtGe9pxL-i5vFFnSyA1n9cM7L8UFBsHWEFHYdG8BwSBmXef8HqdEPwjThEwFvl1g' \
--header 'Authorization: ' \
--form 'image_file=@"/Users/zcz/Pictures/下载.png"' \
--form 'mask=@"/Users/zcz/Pictures/下载 (1).png"' \
--form 'prompt="cat"' \
--form 'model="V_2_TURBO"' \
--form 'magic_prompt_option=""' \
--form 'seed=""' \
--form 'style_type=""' \
--form 'num_images=""'

Responses

🟢200成功

application/json

Body

data

array [object {5}]

required

A list of ImageObjects that contain the generated image(s).
包含生成图像的图像对象列表。

seed

integer

required

0 to 2147483647

prompt

string

required

The prompt used for the generation. This may be different from the original prompt.
用于生成的提示。这可能与原始提示不同。

resolution

string

required

The resolution of the final image.
最终图像的分辨率。

url

string | null

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"
}