---
title: "Generate images with Z-Image from a text prompt"
method: POST
path: "/v2/images/generate/z-image"
tags: ["images-generate"]
---

# Generate images with Z-Image from a text prompt

`POST /v2/images/generate/z-image`

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

## Request body

- GenerateImageZImageRequest
  - `prompt` string, required — The prompt to generate images from.
  - `resolution` string, 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_steps` integer, nullable — Optional diffusion step count. When omitted, the server uses the model's default. Higher values trade latency for quality.
  - `seed` integer — Random seed. Set for reproducible generation.
  - `num_images` integer — The number of images to generate.
  - `async` boolean — 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`.

## Response `200`

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

- GenerateImageZImageResponse — Response returned by `POST /v2/images/generate/z-image`. Synchronous requests (the default) include the generated images in `data`. Requests with `async` set to true omit `data`; poll for completion and results with `GET /v1/generations/{generation_id}` using the returned `generation_id`. The seed reports the value the request resolved to when the caller left it unset.
  - `generation_id` string, required — URL-safe base64 ID of the accepted generation. Accepted by the `GET /v1/generations/{generation_id}` polling endpoint.
  - `data` GeneratedImageObject[] — The generated images, in generation order. Present only for synchronous requests (`async` omitted or false).
    - `url` string, uri, nullable — The direct link to the generated image. Empty when the image did not pass safety checks.
    - `prompt` string, required — The final prompt the image was generated from.
    - `resolution` string, required — The resolution of the generated image, formatted as "WIDTHxHEIGHT".
    - `is_image_safe` boolean, required — Whether the image passed safety checks. If false, `url` is empty.
    - `seed` integer, required — Random seed. Set for reproducible generation.
  - `seed` integer, required — Random seed. Set for reproducible generation.

## Other responses

- `400` — Invalid input provided.
- `401` — Unauthorized.
- `402` — Insufficient credits or quota.
- `422` — The prompt did not pass safety checks.
- `429` — Too many requests.
- `500` — Internal server error.
- `503` — The endpoint is temporarily unavailable.

---

[API](https://skmtc.net/ideogram/apis/ideogram-openapi-3-0.md) · [All operations](https://skmtc.net/ideogram/apis/ideogram-openapi-3-0/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ideogram/ideogram-openapi-3-0/revisions/73707bc35f34/schema)