Sign in
latestOpenAPI 3.0.22026-08-19125272497.5 KB

73707bc35f34

images-generate

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.

post/v2/images/generate/z-image

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.

Example request

{
  "async": false,
  "seed": 12345,
  "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

Random seed. Set for reproducible generation.

Example response

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