ideogram Text Raw Image - API Doc-CometAPI

Generates images synchronously based on a given prompt and optional parameters.
Generates images synchronously based on a given prompt and optional parameters.
The returned image URLs are valid for 24 hours, after which the images cannot be accessed.
The image URLs are the original official links, so please note that they are accessible in your network environment.

Request

Header Params

Authorization

string

optional

Example:

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.

Default:

ASPECT_1_1

model

enum<string>

optional

The model used to generate. Defaults to V_2.

Allowed values:

V_1V_1_TURBOV_2V_2_TURBO

Default:

V_2

magic_prompt_option

enum<string>

optional

Determine if MagicPrompt should be used in generating the request or not

Allowed values:

AUTOONOFF

Default:

AUTO

seed

integer

optional

0 to 2147483647

style_type

enum<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.

Allowed values:

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

🟢200OK

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

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