Generate with GPT Image 2
Generate images with GPT Image 2. Optionally upload source images as
images using multipart/form-data to edit them with the prompt.
Returns results directly by default; set async or supply a
webhook_url to get a generation_id and poll
GET /v2/generations/{generation_id}.
Authentication
API key for access control. Use in the header with the name "Api-Key"
Query parameters
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
A request to generate images with GPT Image 2. Send it as application/json, or as multipart/form-data to include source images.
Optional source images to edit (max 16, max 25MB each; JPEG, PNG, or WEBP). Multipart requests only.
The requested output aspect ratio, for example "1:1", "16:9", or "9:16". Ignored when resolution is provided. Defaults to "1:1".
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
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.
When false (the default), the request waits until the images are ready and returns them in data. When true, the request returns as soon as it is accepted; poll GET /v2/generations/{generation_id} with the returned generation_id for the result.
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.
Response
The generated images (synchronous requests), or an acknowledgement to poll with GET /v2/generations/{generation_id} (async requests).
URL-safe base64 ID of the generation. Use it to poll
GET /v2/generations/{generation_id}.
The generated images, in generation order. Present only for synchronous requests (async omitted or false).