Generate with Z-Image | Ideogram

curl -X POST https://api.ideogram.ai/v2/image/generate/z-image \
     -H "Api-Key: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "prompt": "A futuristic cityscape at golden hour, highly detailed.",
  "resolution": "1024x1024",
  "num_inference_steps": 8,
  "seed": 12345,
  "num_images": 1,
  "async": false,
  "webhook_url": "https://api.example.com/webhooks/ideogram"
}'

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

Generate images from a text prompt with Z-Image. 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-Keystring

API key for access control. Use in the header with the name "Api-Key"

Query parameters

dry_runbooleanOptionalDefaults to false

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 Z-Image.

promptstringRequired1-10000 characters

The prompt to generate images from.

resolutionstring or nullOptional

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 or nullOptional1-128

Optional number of diffusion steps. When omitted, the model's default is used. Higher values improve quality but take longer.

seedintegerOptional0-2147483647

Random seed. Set for reproducible generation.

num_imagesintegerOptional1-8Defaults to 1

The number of images to generate.

asyncbooleanOptionalDefaults to false

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.

webhook_urlstringOptionalformat: "uri"<=2048 characters

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

generation_idstring

URL-safe base64 ID of the generation. Use it to poll GET /v2/generations/{generation_id}.

seedinteger0-2147483647

Random seed. Set for reproducible generation.

datalist of objectsOptional

The generated images, in generation order. Present only for synchronous requests (async omitted or false).

Errors

400

Bad Request Error

401

Unauthorized Error

402

Payment Required Error

422

Unprocessable Entity Error

429

Too Many Requests Error

500

Internal Server Error

503

Service Unavailable Error