Rivya API کا جائزہ

Rivya API v1 ایک ڈویلپر معاہدہ ہے جس کے ذریعے آپ اپنی مصنوعات سے Rivya کے معاون ماڈلز کی صلاحیتیں استعمال کر سکتے ہیں، بشرطیکہ متعلقہ تنصیب میں Public API فعال ہو اور آپ کے اکاؤنٹ کو اس تک رسائی حاصل ہو۔

نافذ شدہ معاہدہ غیر ہم وقت تصویر، ویڈیو اور آڈیو تخلیق، نیز غیر مسلسل یا SSE کے ذریعے مسلسل جواب دینے والی Chat API گفتگو کا احاطہ کرتا ہے۔ یہ Rivya کے ماڈل شناختی نمبروں، اکاؤنٹ کے کریڈٹس، تخلیق کے عوامی کام شناختی نمبروں اور سرور پر محفوظ گفتگو کی نشستوں کو استعمال کرتا ہے۔ کسی راستے کا درج ہونا اس بات کی ضمانت نہیں کہ ہر ماحول، اکاؤنٹ یا فہرستی ماڈل اسے چلا سکتا ہے؛ انضمام سے پہلے براہِ راست رسائی اور ماڈل کی تیاری کی تصدیق کریں۔

API کب استعمال کریں

API اس وقت موزوں ہے جب آپ:

• اپنی ایپ سے تصویر، ویڈیو یا آڈیو تخلیق کے کام جمع کرنا چاہتے ہوں

• غیر مسلسل یا مسلسل گفتگو کے مراحل بھیجنا اور API سے بنی گفتگو کی نشست جاری رکھنا چاہتے ہوں

• بلنگ کو اسی Rivya اکاؤنٹ کے کریڈٹ میزان میں رکھنا چاہتے ہوں

• عوامی کام شناختی نمبر سے کام کی حالت معلوم کرنا چاہتے ہوں

• پیداوار میں زیادہ محفوظ درخواستوں کے لیے یکساں نتیجہ دینے والی دوبارہ کوشش استعمال کرنا چاہتے ہوں

• Studio اور API کا استعمال ایک ہی اکاؤنٹ کی حد میں رکھنا چاہتے ہوں

API، Rivya کی مصنوعات کی ایک سطح ہے۔ عوامی جواب صرف Rivya کے نام اور عوامی خانے استعمال کرتا ہے۔

موجودہ نسخے کی حد

نافذ شدہ v1 نقاطِ رسائی یہ ہیں:

• GET /api/v1/models

• POST /api/v1/generations

• POST /api/v1/files

• GET /api/v1/files/{fileId}

• POST /api/v1/chat/completions

• GET /api/v1/chat/sessions

• GET /api/v1/chat/sessions/{sessionId}

• GET /api/v1/generations/{taskId}

• GET /api/v1/credits

• GET /api/v1/webhooks

• POST /api/v1/webhooks

• GET /api/v1/webhook-events

• GET /api/v1/openapi.json

موجودہ معاہدے میں غیر ہم وقت تخلیقی نتائج کے لیے دستخط شدہ ویب ہکس، Chat API اور سرور سے مسلسل ترسیل کی معاونت رکھنے والا TypeScript SDK بیٹا شامل ہے۔ ویب ہک درخواستیں صرف اس وقت کام کرتی ہیں جب متعلقہ تنصیب میں ویب ہک اور Public API دونوں فعال ہوں۔

توثیق

تخلیق، حالت اور کریڈٹ کے نقاطِ رسائی کے لیے یہ سرنامہ درکار ہے:

Authorization: Bearer rvya_sk_...

API کلید کی ترتیبات سے کلید بنائیں اور بدلیں۔ پیداوار میں کلید استعمال کرنے سے پہلے API توثیق پڑھیں۔

بلنگ کا طریقہ

API درخواستیں وہی Rivya اکاؤنٹ کریڈٹس استعمال کرتی ہیں جو Studio استعمال کرتا ہے۔

تخلیقی کام شروع ہونے پر کریڈٹس مخصوص یا خرچ ہوتے ہیں۔ گفتگو کے ہر مرحلے میں ماڈل پکارنے سے پہلے کریڈٹس مخصوص کیے جاتے ہیں، پھر معاون کا پیغام محفوظ ہونے پر رمزی استعمال کے مطابق حتمی تصفیہ ہوتا ہے۔ تخلیقی یا گفتگو کا کام Rivya کے موجودہ ناکامی کے قواعد کے تحت ناکام ہو تو اسی کے مطابق کریڈٹ واپسی کا عمل لاگو ہوتا ہے۔

صارف کو دکھائے جانے والے کریڈٹ میزان کے لیے API کریڈٹس اور Rivya میں کریڈٹس اور بلنگ پڑھیں۔

پہلے انضمام کا راستہ

1. ترتیبات میں API کلید بنائیں۔

2. عوامی ماڈل شناختی نمبر چننے کے لیے API ماڈلز کی فہرست پکاریں۔

3. ماڈل کے پیرامیٹر جاننے کے لیے ماڈل API حوالہ پڑھیں۔

4. اگر ماڈل کو حوالہ جاتی میڈیا درکار ہو تو Files API سے اپ لوڈ کریں۔

5. تخلیق شروع کریں کے ذریعے کام جمع کریں۔

6. کام کے کامیاب یا ناکام ہونے تک تخلیق کی حالت معلوم کرتے رہیں۔ اگر متعلقہ تنصیب اور اکاؤنٹ میں ویب ہکس فعال ہوں تو اس کے بجائے API ویب ہکس کے دستخط شدہ تکمیلی واقعات حاصل کر سکتے ہیں۔

7. گفتگو کے ماڈلز کے لیے تخلیقی نقطۂ رسائی کے بجائے Chat API استعمال کریں۔ گفتگو کے تصویری منسلکات میں Files API کی file_id قدروں کا حوالہ دینا ضروری ہے۔

متعلقہ صفحات

• API فوری آغاز

• API توثیق

• Rivya TypeScript SDK

• ماڈل API حوالہ

• Chat API

• API ویب ہکس

• API خرابیاں اور حدیں