Sign in
latestOpenAPI 3.0.22026-08-21134292561.4 KB

898026c78d68

images-generate

Generate images with Ideogram 2.0 from a text prompt

Generate one or more images from a text prompt with Ideogram 2.0, with an optional style type and negative prompt. Set rendering_speed to TURBO for faster, lower-cost generation.

By default the request blocks until the images are ready and returns them in data. Set async to true to return immediately after the request is accepted, then poll for completion and results with GET /v1/generations/{generation_id} using the returned generation_id.

post/v2/images/generate/ideogram-v2

Request body

promptstring required

The prompt to generate images from.

negative_promptstring

Description of what to exclude from the images. Descriptions in the prompt take precedence over descriptions in the negative prompt.

seedinteger

Random seed. Set for reproducible generation.

aspect_ratio'1x3' | '3x1' | '1x2' | '2x1' | '9x16' | '16x9' | '10x16' | '16x10' | '2x3' | '3x2' | '3x4' | '4x3' | '4x5' | '5x4' | '1x1'

The aspect ratio to use for image generation, which determines the image's resolution. Cannot be used in conjunction with resolution. Defaults to 1x1.

rendering_speed'TURBO' | 'DEFAULT'

The rendering speed to use. TURBO generates faster at a lower cost.

magic_prompt'AUTO' | 'ON' | 'OFF'

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

num_imagesinteger

The number of images to generate.

style_type'AUTO' | 'GENERAL' | 'REALISTIC' | 'DESIGN' | 'RENDER_3D' | 'ANIME'

The style type to generate with. When omitted, the model's default styling is used; pass AUTO to have a style selected automatically from the prompt.

enable_copyright_detectionboolean nullable

Optional. Opt this request into post-generation copyright detection. Adds detection latency; flagged images come back with is_image_safe: false.

asyncboolean

When false (the default), the request blocks until the images are ready and returns them in data. When true, the request returns as soon as it is accepted; poll for completion and results with GET /v1/generations/{generation_id} using the returned generation_id.

Example request

{
  "magic_prompt": "",
  "aspect_ratio": null,
  "async": false,
  "style_type": "REALISTIC",
  "seed": 12345,
  "rendering_speed": "DEFAULT",
  "negative_prompt": "negative_prompt",
  "enable_copyright_detection": true,
  "prompt": "prompt",
  "num_images": 1
}

Response

The generated images (synchronous requests), or an acknowledgement to poll with GET /v1/generations/{generation_id} (async requests).

generation_idstring required

URL-safe base64 ID of the accepted generation. Accepted by the GET /v1/generations/{generation_id} polling endpoint.

seedinteger required

Random seed. Set for reproducible generation.

Example response

{
  "data": [
    {
      "seed": 12345,
      "prompt": "prompt",
      "resolution": "1024x1024",
      "url": "https://openapi-generator.tech",
      "is_image_safe": true
    },
    {
      "seed": 12345,
      "prompt": "prompt",
      "resolution": "1024x1024",
      "url": "https://openapi-generator.tech",
      "is_image_safe": true
    }
  ],
  "seed": 12345,
  "generation_id": "generation_id"
}