کلید بنائیں
لاگ اِن کریں، ترتیبات میں API کلیدیں کھولیں، محدود دائرۂ اجازت والی کلید بنائیں اور مکمل راز فوراً محفوظ کریں۔
Rivya API
فوری آغاز کی ساخت
ماڈلز کی سطح
تازہ ہونے والی فہرست
بلنگ
مشترک کریڈٹس
ابتدائی نسخہ
کام اور چیٹ
رسائی
API کلیدیں
حقیقی درخواست کے لیے Rivya API کی اور اکاؤنٹ میں دستیاب کریڈٹس ضروری ہیں۔ عوامی مثالیں نمائشی خفیہ قدریں استعمال کرتی ہیں اور ماڈلز کو بنا شناخت نہیں بلاتیں۔
curl https://rivya.ai/api/v1/generations \
-H "Authorization: Bearer rvya_sk_..." \
-H "Content-Type: application/json" \
-H "Idempotency-Key: demo-job-001" \
-d '{
"model": "z-image",
"prompt": "Editorial product photo on a clean studio set"
}'{
"id": "task_public_id",
"status": "queued",
"model": "z-image",
"reserved_credits": 1,
"result": null,
"error": null
}آن لائن خرابی جانچنے کا آلہ
ڈیبگر ہر ملاقاتی کے لیے نمائشی حالت سے شروع ہوتا ہے۔ تخلیقی منتخب کنندہ ایسے غیر چیٹ ماڈلز دکھاتا ہے جنہیں فائلیں اپ لوڈ کیے بغیر آزمایا جا سکتا ہے، جبکہ فائلز پینل لاگ اِن صارفین کو عارضی API کی کے ساتھ /api/v1/files آزمانے دیتا ہے۔ چیٹ کی مثالیں API دستاویزات میں ہیں۔
اکاؤنٹ کی حالت
اکاؤنٹ جانچا جا رہا ہے
فعال کلید کا ابتدائی حصہ
پہلے کلید بنائیں
موجودہ کریڈٹس
جانچنے کے لیے لاگ اِن کریں
نمائشی طریقہ کبھی ماڈل کو نہیں بلاتا اور کریڈٹس خرچ نہیں کرتا۔
کلید صرف اس درخواست کے لیے چسپاں کریں۔ صفحہ تازہ ہونے کے بعد خرابی جانچنے کا آلہ اسے محفوظ نہیں رکھتا۔
Files API اپ لوڈ آزمائش
POST /api/v1/files کے ذریعے حوالہ جاتی میڈیا اپ لوڈ کریں، پھر واپس ملنے والا URL اور دورانیے کا ٹوکن ایسے ماڈل کے `params.referenceMediaItems` میں نقل کریں جو حوالہ جاتی اِن پٹس کی معاونت کرتا ہے۔
منتخب ماڈل معاون MIME اقسام، سائز اور دورانیے کے قواعد پر قابو رکھتا ہے۔ فعال اپ لوڈز کے لیے آپ کی عارضی API کی ضروری ہے اور حقیقی اپ لوڈ سروس بلائی جا سکتی ہے۔
{
"model": "z-image",
"prompt": "صاف ستھرے اسٹوڈیو میں مصنوعات کی تدوینی تصویر",
"params": {
"aspect_ratio": "1:1"
}
}{
"id": "mock_task_001",
"status": "queued",
"model": "z-image",
"reserved_credits": 1,
"final_credits": 0,
"result": null,
"error": null
}{
"id": "file_mock_001",
"object": "file",
"kind": "image",
"file_name": "reference.png",
"mime_type": "image/png",
"size_bytes": 245760,
"url": "https://media.example/reference.png",
"duration_seconds": null,
"duration_token": null,
"created_at": "2026-05-11T00:00:00.000Z",
"expires_at": null
}{
"params": {
"referenceMediaItems": [
{
"url": "https://media.example/reference.png",
"kind": "image",
"name": "reference.png",
"mimeType": "image/png",
"sizeBytes": 245760
}
]
}
}کام کی حالت
بنیادی کریڈٹس کا اندازہ
1
حالت
قطار میں
آغاز کا راستہ
لاگ اِن کریں، ترتیبات میں API کلیدیں کھولیں، محدود دائرۂ اجازت والی کلید بنائیں اور مکمل راز فوراً محفوظ کریں۔
کام بھیجنے سے پہلے API ماڈل حوالہ پڑھیں یا /api/v1/models بلا کر ماڈل شناختی نام، پیرامیٹرز، چیٹ صلاحیتیں اور اِن پٹ کی تیاری دیکھیں۔
دہری کارروائی سے محفوظ تخلیقی درخواست بھیجیں، عوامی کام کے اینڈ پوائنٹ سے حالت بار بار پوچھیں، تخلیقی جوابی اطلاعات کے لیے دستخط شدہ ویب ہکس استعمال کریں، یا اختیاری SSE اسٹریمنگ کے ساتھ Chat API کی باری بھیجیں۔
ابتدا میں کیا دستیاب ہے
یہ API Rivya کی مصنوعات کا حصہ ہے۔ یہ Rivya ماڈل IDs، Rivya کریڈٹس، عوامی ٹاسک کی حالتیں اور ماڈل کیٹلاگ سے منسلک دستاویزات استعمال کرتی ہے۔
پرامپٹ اور معاون ماڈل پیرامیٹرز کے ساتھ تصویری کام بھیجیں، پھر عوامی نتائج کے لیے حالت دوبارہ جانچیں۔
اسٹوڈیو میں استعمال ہونے والے انہی کام اور کریڈٹ کی ترتیبات کے ساتھ غیر ہم وقت ویڈیو کام چلائیں۔
اسی اکاؤنٹ، بیلنس اور تاریخ کی حدود کے ذریعے API پر دستیاب آڈیو ماڈلز استعمال کریں۔
API درخواستیں اور اسٹوڈیو کا استعمال ایک ہی Rivya بیلنس سے کریڈٹس لیتے ہیں، جس میں محفوظ کریڈٹس اور ناکامی سنبھالنے کا عمل بھی شامل ہے۔
نسخے کی حد
یہ صفحہ دستیاب API صلاحیتوں کو آئندہ اضافوں سے الگ دکھاتا ہے، تاکہ آپ آج فعال سہولتوں کے مطابق منصوبہ بندی کر سکیں۔
API سے بنے سیشنز، اکاؤنٹ کریڈٹس اور اختیاری Files API تصویری منسلکات کے ساتھ، عام جواب اور SSE اسٹریمنگ دونوں طرح کی باریوں کے لیے دستیاب ہے۔
حوالہ جاتی تصویر، ویڈیو اور آڈیو اپ لوڈز کے لیے دستیاب ہے۔ جب ماڈل کا صفحہ `params.referenceMediaItems` مانگے تو تخلیق سے پہلے اسے استعمال کریں۔
ان پیداواری انضمامات کے لیے دستیاب ہے جنہیں کامیاب یا ناکام نتیجہ سازی کے کاموں کی دستخط شدہ واپسی اطلاع درکار ہو۔
تصدیق، درخواستی مواد، جوابات، دہری کارروائی سے بچاؤ، ماڈل پیرامیٹرز اور خرابی کوڈ پڑھیں۔
دستاویزات کھولیںAPI کی بنائیں اور اسے ایک بار نقل کریں۔ کی بدلنے کے لیے محفوظ ترتیبات والے حصے میں نئی کی بنائیں اور پرانی منسوخ کر دیں۔
کیز سنبھالیںپہلے نمائشی مثالیں استعمال کریں؛ حقیقی خرابی کی جانچ کے لیے لاگ اِن، API کی اور اکاؤنٹ کریڈٹس ضروری ہیں۔
طریقۂ کار کا معائنہ کریں