↓
Rivya AI Docs
Model API guides

Z-Image API reference

Check Z-Image availability, inputs, parameters, file requirements, credit pricing, and request examples for Rivya Public API v1. Model ID: z-image.

Available via APIText input readyImage
API model ID

z-image

Inputs

text

Files API

Not required for the minimal request

Credit pricing

Credit rate: 0.8 per image The final cost is rounded up to whole credits.

Capability

Image

Billing

FIXED

Prompt limit

1000 characters

Request fields

Set model at the top level. Put model-specific controls and reference inputs in params, using the format documented for this model.

KeyTypeRequiredDefaultDescription
modelstringYesz-imageSet model to z-image.
promptstringYes-Maximum 1000 characters for this model.
paramsobjectNo-The model-specific params object. Use the documented keys and reference-file format for this model.
client_request_idstringNo-Optional ID for tracing this request in your system. It does not replace Idempotency-Key.

Model parameters

KeyTypeRequiredDefaultRangeOptionsDescription
aspect_ratioselectNo1:1-1:1, 4:3, 3:4, 16:9, 9:16Aspect ratio

Minimal request

{
  "model": "z-image",
  "prompt": "A product bottle on a light gray background, lit softly from the left.",
  "params": {
    "aspect_ratio": "1:1"
  }
}

Example response

An accepted generation request returns a task ID. Poll the status endpoint until the task succeeds or fails. A status request failure does not mean generation failed.

{
  "id": "task_z_image_example",
  "status": "queued",
  "model": "z-image",
  "reserved_credits": 1,
  "final_credits": 0,
  "settlement_status": "RESERVED",
  "created_at": "2026-05-11T00:00:00.000Z",
  "updated_at": "2026-05-11T00:00:00.000Z",
  "result": null,
  "error": null
}

Common errors

validation_failed, insufficient_credits, idempotency_conflict, rate_limited, not_found

An accepted generation request returns a task ID. Poll the status endpoint until the task succeeds or fails. A status request failure does not mean generation failed.