Generate - API reference

Generates images synchronously based on a given prompt and optional parameters.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Header Params

Authorization

string

optional

Default:

Body Params application/json

image_request

object

required

prompt

string

required

The prompt to use to generate the image.
生成图像的提示。

aspect_ratio

string

optional

(Cannot be used in conjunction with resolution) The aspect ratio to use for image generation, which determines the image's resolution. Defaults to ASPECT_1_1.
（不能与分辨率一起使用）用于图像生成的宽高比，决定图像的分辨率。默认为 ASPECT_1_1。

Default:

ASPECT_1_1

model

string

optional

The model used to generate. Defaults to V_2.
用于生成的模型。默认为 V_2。

Default:

V_2

Examples:

V_1V_1_TURBOV_2V_2_TURBO

magic_prompt_option

string

optional

Determine if MagicPrompt should be used in generating the request or not
确定是否应该在生成请求时使用 MagicPrompt

Default:

AUTO

Examples:

AUTOONOFF

seed

integer

optional

0 to 2147483647

style_type

string

optional

The style type to generate with; this is only applicable for models V_2 and above and should not be specified for model versions V_1.
生成的样式类型；这仅适用于 V_2 及以上版本的模型，不应为 V_1 版本的模型指定。
示例值：GENERAL、REALISTIC、DESIGN、RENDER_3D、ANIME

Examples:

GENERALREALISTICDESIGNRENDER_3DANIME

num_images

string

optional

negative_prompt

string

optional

Description of what to exclude from an image. Descriptions in the prompt take precedence to descriptions in the negative prompt.
描述从图像中排除的内容。提示中的描述优先于负提示中的描述。

resolution

string

optional

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

Example:

RESOLUTION_832_1152

Example

{
  "image_request": {
    "model": "V_2_TURBO",
    "magic_prompt_option": "AUTO",
    "seed": 111,
    "prompt": "cat",
    "num_images": 1
  }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

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