Skip to main content
POST
Z Image

Pricing

Fixed API prices in USD.
Price: $0.003 per request
These aliases are accepted for compatibility only and are not shown in the request schema.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-Webhook-URL
string<uri>

URL to receive a POST request when the job completes. The webhook will receive the job data including results.

Body

application/json
prompt
string
required
aspect_ratio
enum<string>
required

Aspect ratio. One of: 1:1, 4:3, 2:3, 16:9, 9:16.

Available options:
1:1,
4:3,
2:3,
16:9,
9:16
resolution
enum<string>
required

Resolution scale. One of: 1K.

Available options:
1K
seed
number
denoising_strength
number
default:0.6
Required range: 0 <= x <= 1
styles
object[]

Styles (typically LoRAs) to use for the generation

skip_prompt_expansion
boolean
default:false
image_url
string<uri> | null

Can be an external URL, base64 data URI, or uploaded asset URL.

Maximum string length: 1024
style_images
object[]

Image prompts to use for the generation

Maximum array length: 1

Response

The resulting job data. This will be returned in a pending state until the job is completed. See /jobs/{id} for retrieving the results.

job_id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
status
enum<string>
required
Available options:
backlogged,
queued,
scheduled,
processing,
sampling,
intermediate-complete,
completed,
failed,
cancelled
created_at
string<date-time>
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
completed_at
null
required
result
null
required
error
object