images-generate

Generate images with GPT Image 2.5 Sunburst, from a text prompt or by editing source images

Generate one or more images with GPT Image 2.5 Sunburst — the quality variant of GPT Image 2.5, optimized for fine detail at higher latency than Flare. The prompt is consumed by the model directly, without rewriting.

Supplying source images turns the request into an edit: the model applies the prompt to the sources. Provide them either as image_asset_identifiers references (images already stored with Ideogram) or as raw images bytes (multipart requests only) — if both are supplied, the references win and the bytes are ignored. Without source images the prompt alone drives the generation.

The output size follows resolution when provided, otherwise the closest size the model supports for aspect_ratio.

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.

Supplying a webhook_url makes the request asynchronous whatever async says: the response returns as soon as the request is accepted, and the finished result is POSTed to that URL.

post/v2/image/generate/gpt-image-2-5-sunburst

Query parameters

dry_runboolean

When true, the request is validated and priced but not run: nothing is generated, stored, or billed, and no safety review is performed. The response is a PriceQuote object instead of the usual response for this endpoint. Send exactly the request you would send to generate, so the quote reflects the same options.

Request body

promptstring required

The prompt to generate images from, or the edit instruction to apply when source images are supplied. The model consumes it directly, without rewriting.

imagesstring[]

The source images to edit (max 16, max size 25MB per image), as raw bytes; only JPEG, PNG, and WEBP formats are supported. Multipart requests only; ignored if image_asset_identifiers is also supplied.

maskstring binary

An optional mask applied to the first source image, as raw bytes (multipart requests only; JPEG, PNG, or WEBP, max 25MB). Fully transparent mask pixels mark the areas to edit; the mask must have the same dimensions as the first source image. Requires source images uploaded as raw images bytes in the same request; masks cannot be combined with image_asset_identifiers.

background'auto' | 'transparent' | 'opaque'

The output background. transparent returns images with an alpha channel, opaque forces a solid background, and auto lets the model decide from the prompt.

quality'auto' | 'low' | 'medium' | 'high'

How much rendering effort the model spends. Lower tiers return sooner and cost less; auto lets the model choose, which it currently renders at high.

num_imagesinteger

The number of images to generate.

seedinteger

Random seed. Set for reproducible generation.

aspect_ratiostring

The requested output aspect ratio, for example "1:1", "16:9", or "9:16". Ignored when resolution is provided. Defaults to "1:1".

resolutionstring

Exact output resolution, formatted as "WIDTHxHEIGHT", for example "2048x2048" or "1920x1088". When provided, this takes precedence over aspect_ratio. The dimensions must satisfy GPT Image 2.5 Sunburst constraints: each side is a multiple of 16, the largest side is at most 3840px, the long:short ratio is at most 3:1, and total pixels are between 655360 and 8294400 inclusive.

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.

webhook_urlstring uri

HTTPS URL that Ideogram delivers the generated result to. Ideogram sends a JSON POST to this URL once all images for the request have finished generating. The body mirrors the synchronous generate response: request_id, created, and a data array containing every generated image (url, prompt, resolution, seed, is_image_safe). Each delivery is signed with Ed25519 and verifiable against the public keys at https://api.ideogram.ai/v1/.well-known/jwks.json. Must be HTTPS; private and loopback hosts and the cloud metadata service are rejected.

privateboolean nullable

When true or omitted, the output is kept private to your account. Set to false to publish the output to the public feed. Enterprise accounts always generate privately.

target_collection_idstring

A collection you can write to, by its URL-safe base64 collection id. The output images are added to it when the request completes.

Example request

{
  "image_asset_identifiers": [
    {
      "asset_type": "RESPONSE",
      "asset_id": "7uS_VESkRI6O3-sVgHQp_A"
    }
  ],
  "seed": 12345,
  "webhook_url": "https://api.example.com/webhooks/ideogram"
}

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