Generate images with Z-Image from a text prompt

Generate one or more images from a text prompt with Z-Image. The base model is pinned server-side.

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.

Request body

promptstring required

The prompt to generate images from.

resolutionstring nullable

Exact output resolution, formatted as "WIDTHxHEIGHT". Each side must be a positive multiple of 16 and the total area must not exceed 1,048,576 pixels (1024×1024). When omitted, the model's default 1024×1024 is used.

num_inference_stepsinteger nullable

Optional diffusion step count. When omitted, the server uses the model's default. Higher values trade latency for quality.

seedinteger

Random seed. Set for reproducible generation.

num_imagesinteger

The number of images to generate.

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

{
  "async": false,
  "private": true,
  "seed": 12345,
  "webhook_url": "https://api.example.com/webhooks/ideogram",
  "target_collection_id": "target_collection_id",
  "prompt": "A futuristic cityscape at golden hour, highly detailed.",
  "resolution": "1024x1024",
  "num_images": 1,
  "num_inference_steps": 8
}

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