Generate（文生图） - Shell API Docs

请求参数

Header 参数

Authorization

string

必需

默认值:

Body 参数application/json

image_request

object

必需

prompt

string

必需

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

aspect_ratio

string

可选

(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。

默认值:

ASPECT_1_1

model

string

可选

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

默认值:

V_2

示例值:

V_1V_2V_1_TURBOV_2_TURBO

magic_prompt_option

string

可选

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

默认值:

AUTO

示例值:

AUTOONOFF

seed

integer

可选

0 to 2147483647

style_type

string

可选

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 版本的模型指定。

示例值:

GENERALREALISTICDESIGNRENDER_3DANIME

negative_prompt

string

可选

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

resolution

string

可选

(For model_version for 2.0 only, cannot be used in conjunction with aspect_ratio) The resolution to use for image generation, represented in width x height. If not specified, defaults to using aspect_ratio. （仅适用于 2.0 的 model_version，无法与 aspect_ratio 同时使用）用于图像生成的分辨率，以宽 x 高表示。如果没有指定，则默认为使用 aspect_ratio。

示例值:

RESOLUTION_576_1472

示例

{
    "image_request": {
        "model": "V_2",
        "magic_prompt_option": "AUTO",
        "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 is 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.",
        "aspect_ratio": "ASPECT_10_16",
        "seed": 12345,
        "style_type": "GENERAL",
        "negative_prompt": "string",
        "resolution": "string"
    }
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST '/ideogram/v1/generate' \
--header 'Authorization;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "image_request": {
        "model": "V_2",
        "magic_prompt_option": "AUTO",
        "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 is 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.",
        "aspect_ratio": "ASPECT_10_16",
        "seed": 12345,
        "style_type": "GENERAL",
        "negative_prompt": "string",
        "resolution": "string"
    }
}'

返回响应

🟢200成功

application/json

Body

data

array [object {5}]

必需

seed

integer

必需

0 to 2147483647

prompt

string

必需

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

resolution

string

必需

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

url

string

必需

The direct link to the image generated. 生成的图像的直接链接。

is_image_safe

boolean

必需

Whether this request passes safety checks. If false, the url field will be empty. 该请求是否通过安全检查。如果为假，网址字段将为空。

created

string

必需

The time the request was created. 请求创建的时间。

示例

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