Z-Image کو Rivya Public API v1 کے ذریعے model id z-image، supported inputs، parameters، Files API rules، credits اور response examples کے ساتھ استعمال کریں۔

API کے ذریعے availableText input readyتصویر

API model id

z-image

Inputs

text

Files API

Minimal request کے لیے required نہیں

Base credits

Capability

تصویر

Billing

FIXED

Prompt limit

1000 characters

Request contract

model id کو top level پر بھیجیں۔ Model-specific controls params میں رہتے ہیں۔

Key	Type	Required	Default	Description
model	string	Yes	z-image	z-image API model id استعمال کریں۔
prompt	string	Yes	-	اس model کے لیے زیادہ سے زیادہ 1000 characters۔
params	object	No	-	Model-specific parameter object۔ allowed keys کے لیے نیچے والی rows استعمال کریں۔
client_request_id	string	No	-	آپ کے system میں requests trace کرنے کے لیے optional client-side id۔

Model parameters

Key	Type	Required	Default	Range	Options	Description
aspect_ratio	select	No	1:1	-	1:1, 4:3, 3:4, 16:9, 9:16	Aspect ratio

Minimal request

{
  "model": "z-image",
  "prompt": "A clean editorial product image on a soft studio background",
  "params": {
    "aspect_ratio": "1:1"
  }
}

Create response

create endpoint ایک public task id واپس کرتا ہے۔ task succeeded یا failed ہونے تک status endpoint poll کریں۔

{
  "id": "task_z_image_example",
  "status": "queued",
  "model": "z-image",
  "reserved_credits": 1,
  "final_credits": 0,
  "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