Skip to main content
POST
Z-Image
Z-Image image generation model

Authorizations

Authorization
string
header
required

API Key for API endpoints

Body

prompt
string
required

A text description of the image you want to generate

image_url
string<uri>

Input image for image-to-image generation

aspect_ratio
enum<string>
default:1:1

Aspect ratio of the generated image

Available options:
1:1,
2:3,
3:2,
3:4,
4:3,
4:5,
5:4,
9:16,
16:9,
21:9
resolution
enum<string>
default:720p

Image generation resolution. 1K: standard, 2K: high-res.

Available options:
720p,
1080p
output_format
enum<string>
default:jpg

Format of the output image

Available options:
jpg,
png
n
integer
default:1

Number of results to generate (1-4)

Required range: 1 <= x <= 4

Response

Generation submission accepted

id
string
required

Generation id.

status
enum<string>
required

Queue status

Available options:
IN_QUEUE,
IN_PROGRESS,
COMPLETED,
FAILED,
CANCELED
input
Input · object
required

Normalized input payload for the generation task.

usage
object
required

Credit usage breakdown for the request

code
string

Machine-readable generation error code. Present when status is FAILED.

message
string

Sanitized human-readable failure message. Present when status is FAILED.