Z-Image کو Rivya Public API v1 کے ذریعے ماڈل ID z-image، معاون اِن پٹس، پیرامیٹرز، Files API قواعد، کریڈٹس اور جواب کی مثالوں کے ساتھ استعمال کریں۔

API کے ذریعے دستیابمتنی اِن پٹ تیارتصویر

API ماڈل ID

z-image

اِن پٹس

text

Files API

کم سے کم درخواست کے لیے ضروری نہیں

بنیادی کریڈٹس

per_image · default=0.8 · ⌈total⌉

صلاحیت

تصویر

بلنگ

FIXED

پرامپٹ کی حد

1000 حروف

درخواست کا معاہدہ

`model` ID کو بالائی سطح پر بھیجیں۔ ماڈل کے مخصوص کنٹرولز `params` میں رہتے ہیں۔

کلید	قسم	ضروری	طے شدہ	وضاحت
model	string	ہاں	z-image	API ماڈل ID کے طور پر z-image استعمال کریں۔
prompt	string	ہاں	-	اس ماڈل کے لیے زیادہ سے زیادہ 1000 حروف۔
params	object	نہیں	-	ماڈل کا مخصوص پیرامیٹر آبجیکٹ۔ اجازت یافتہ کلیدوں کے لیے نیچے والی قطاریں دیکھیں۔
client_request_id	string	نہیں	-	اپنے نظام میں درخواستوں کا سراغ رکھنے کے لیے اختیاری صارف طرفہ ID۔

ماڈل پیرامیٹرز

کلید	قسم	ضروری	طے شدہ	حد	اختیارات	وضاحت
aspect_ratio	select	نہیں	1:1	-	1:1, 4:3, 3:4, 16:9, 9:16	Aspect ratio

کم سے کم درخواست

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

تخلیقی جواب

تخلیقی اینڈ پوائنٹ عوامی کام کی ID واپس کرتا ہے۔ کام کے کامیاب یا ناکام ہونے تک حالت والے اینڈ پوائنٹ سے جانچتے رہیں۔

{
  "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
}

عام خرابیاں

validation_failed, insufficient_credits, idempotency_conflict, rate_limited, not_found

Z-Image API انضمام

درخواست کا معاہدہ

ماڈل پیرامیٹرز

کم سے کم درخواست

تخلیقی جواب

عام خرابیاں

متعلقہ API دستاویزات