Rivya API کیا ہے؟

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

یہ Rivya Studio سے الگ مصنوعات نہیں۔ یہ وہی اکاؤنٹ حد، کریڈٹ بیلنس اور عوامی ماڈل تہہ استعمال کرتی ہے جو Rivya میں نظر آتی ہے۔ فرق صرف یہ ہے کہ کام کیسے شروع ہوتا ہے: Studio میں کلک کرنے کے بجائے آپ کی ایپلیکیشن API کلید کے ساتھ درخواست بھیجتی ہے۔

اینڈ پوائنٹس کی تفصیل کے لیے Rivya API کا تعارف اور Rivya API کا فوری آغاز پڑھیں۔ یہ مضمون مصنوعات کی سطح پر بتاتا ہے کہ API کس لیے ہے، کہاں موزوں ہے اور کب پہلا راستہ نہیں ہونی چاہیے۔

مختصر جواب

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

نافذ شدہ API سطح میں یہ چیزیں شامل ہیں:

• API ماڈل فہرست کے ذریعے ماڈل تلاش کرنا

• تصویر، ویڈیو اور آڈیو بنانے کے غیر ہم وقتی ٹاسک

• حوالہ جاتی میڈیا مانگنے والے ماڈلز کے لیے Files API اپ لوڈز

• عوامی ٹاسک شناخت کے ذریعے تخلیق کی حالت دیکھنا

• اکاؤنٹ کریڈٹس کی جانچ

• Chat API کے پیغامات، اختیاری SSE سلسلے سمیت

• تخلیق مکمل ہونے پر دستخط شدہ ویب ہکس، جب اس تنصیب میں فعال ہوں

• کلائنٹ ریپر چاہنے والی ٹیموں کے لیے TypeScript SDK بیٹا

عوامی ڈویلپر مرکز ڈویلپرز ہے۔ رہنمائی، API کلید کی ترتیبات اور محفوظ جانچ کے لیے یہی بہتر نقطۂ آغاز ہے۔

Rivya API کیوں فراہم کرتا ہے

Studio اس وقت مفید ہے جب کوئی شخص ماڈل چن رہا ہو، ہدایت بنا رہا ہو، نتائج کا جائزہ لے رہا ہو اور اگلا قدم طے کر رہا ہو۔

API اس وقت مفید ہے جب یہی فیصلہ بار بار دہرائے جانے والے مصنوعات یا عملی طریقے میں بدل چکا ہو۔

API رسائی فعال ہو تو عام مثالیں یہ ہیں:

• فروخت کنندہ کا خاکہ ملنے پر مصنوعات خود تصویری صورتیں بنائے

• تشہیری عمل منظم مہماتی ان پٹس سے بصری مسودے تیار کرے

• اندرونی آلہ براؤزر کھلوائے بغیر ویڈیو یا آڈیو ٹاسک جمع کرائے

• معاون یا مواد کا نظام اپنے انٹرفیس میں چیٹ ماڈل کا جواب لے

• پس منظر کی خدمت ٹاسک مکمل ہونے پر دستخط شدہ اطلاع حاصل کرے

ان صورتوں میں Rivya API کام کو اسی Rivya اکاؤنٹ سے جوڑے رکھتی ہے؛ بلنگ، ماڈل کے انتخاب اور ٹاسک کی حالت کے لیے الگ نظام ضروری نہیں ہوتا۔

API کس چیز کی جگہ نہیں لیتی

API براہ راست Rivya استعمال کرنے کی ہر وجہ ختم نہیں کرتی۔

Studio یا عوامی عملی صفحات اس وقت استعمال کریں جب:

• ہدایت کو ابھی انسانی تلاش درکار ہو

• ماڈل کا انتخاب مستحکم نہ ہو

• تخلیق کار کو نتائج ساتھ ساتھ دیکھنے ہوں

• منصوبہ محفوظ ہسٹری اور انسانی جائزے پر منحصر ہو

• ٹیم نے ابھی ان پٹ اور نتیجے کی دہرائی جانے والی صورت طے نہ کی ہو

طریقۂ کار خودکار بنانے کے لیے کافی واضح ہو جائے تو API استعمال کریں۔

یہ حد اہم ہے۔ مبہم تخلیقی سوال عموماً پہلے Studio میں آتا ہے، جبکہ متوقع ان پٹس والا معلوم پیداواری عمل API میں منتقل ہو سکتا ہے۔

بنیادی اجزا

API کو چھ باہم مربوط حصوں کے طور پر سمجھیں۔

درخواست اور جواب کی عین ساخت کے لیے API دستاویزات اصل حوالہ ہیں۔ یہ مضمون صرف یہ طے کرنے میں مدد دیتا ہے کہ پہلے کون سا حصہ چاہیے۔

کریڈٹس کیسے کام کرتے ہیں

API کا استعمال Studio کی طرح اسی Rivya اکاؤنٹ کے کریڈٹ بیلنس سے کٹتا ہے۔

اس لیے API کوئی بے نام ماڈل واسطہ نہیں۔ ہر درخواست Rivya اکاؤنٹ سے متعلق، اسی اکاؤنٹ کی API کلید کے ذریعے اور API کریڈٹس میں بیان کردہ مصنوعات کی حد کے تحت ہوتی ہے۔

ٹیمیں Studio میں دستی آزمائش کر کے دہرائے جانے والے حصے کو الگ بلنگ نظام بنائے بغیر انضمام میں منتقل کر سکتی ہیں۔

فائلیں کہاں شامل ہوتی ہیں

کچھ ماڈل صرف متن سے چل سکتے ہیں، جبکہ دوسروں کو حوالہ جاتی تصویر، ویڈیو یا آڈیو درکار ہوتی ہے۔

API انضمام میں یہ حوالے Files API سے گزرنے چاہئیں۔ اپ لوڈ ایک منظم فائل ریکارڈ بناتا ہے جسے معاون ماڈل کے پیرامیٹرز میں دیا جا سکتا ہے۔

عملی اصول سادہ ہے:

• ماڈل صرف متن قبول کرے تو تخلیق کے اینڈ پوائنٹ سے شروع کریں

• ماڈل حوالہ جاتی میڈیا مانگے تو پہلے فائل اپ لوڈ کریں

• تصویر منسلک کرنے والے چیٹ ماڈل کے لیے Chat API اور فائل شناخت استعمال کریں

انضمام کو صرف براؤزر کے اپ لوڈ یا محفوظ Studio نشستوں کے گرد نہ بنائیں؛ API کی اپنی عوامی فائل حد اسی مقصد کے لیے ہے۔

ویب ہکس کہاں مفید ہیں

حالت بار بار دیکھنا پہلی کوشش کا آسان راستہ ہے۔ ٹاسک جمع کریں، عوامی شناخت محفوظ کریں اور کامیابی یا ناکامی تک حالت دیکھتے رہیں۔

اگر اس تنصیب میں ویب ہکس فعال ہوں تو پیداواری عمل میں یہ صورتیں مفید ہیں:

• ہر ٹاسک کی حالت دیکھنے والا الگ کارکن نہ رکھنا ہو

• تخلیق مکمل ہونے پر آپ کی ایپ ریکارڈ تازہ کرنا چاہے

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

• ناکام ٹاسک کو واضح بحالی کے راستے میں منتقل کرنا ہو

معاہدے کے لیے API Webhooks پڑھیں اور ڈیزائن سے پہلے دستیابی کی تصدیق کریں۔ وصول کنندہ محدود رکھیں: دستخط جانچیں، نقل واقعات محفوظ طور پر سنبھالیں اور لاگز میں خفیہ اقدار نہ لکھیں۔

اچھا پہلا API منصوبہ

بہترین پہلا API منصوبہ عموماً چھوٹا اور واضح ہوتا ہے۔

مثلا:

1. تصدیق کریں کہ اس تنصیب اور اکاؤنٹ کے لیے API رسائی فعال ہے۔

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

3. ماڈل فہرست حاصل کریں۔

4. API کے لیے تیار ایک ماڈل چنیں۔

5. idempotency کلید کے ساتھ ایک تخلیقی ٹاسک بھیجیں۔

6. حالت کا اینڈ پوائنٹ بار بار دیکھیں۔

7. پہلے اور بعد کے کریڈٹس جانچیں۔

8. اس کے بعد ہی وہ Files API، Chat API یا Webhooks شامل کریں جو تنصیب مہیا کرتی ہے۔

یہ راستہ ہر API خصوصیت کو پہلی جانچ میں ملائے بغیر کام کرنے والا انضمام فراہم کرتا ہے۔

API کب غلط نقطۂ آغاز ہے

API شاید درست پہلا قدم نہ ہو اگر:

• ٹیم نے ابھی ماڈل خاندان نہیں چنا

• مطلوبہ نتیجہ ہر کوشش میں بدل رہا ہے

• ہدایت انسانی ذوق اور جائزے پر منحصر ہے

• انضمام کریڈٹ خرچ ان لوگوں سے چھپا دے گا جنہیں اسے سمجھنا چاہیے

• مصنوعات کو خودکاری سے پہلے عوامی نمونہ چاہیے

ان صورتوں میں Image، Video، Audio، Chat یا AI Models سے شروع کریں۔ راستہ دہرائے جانے کے قابل ہو جائے تو مستحکم حصہ API میں منتقل کریں۔

اس کے بعد کہاں جائیں

• عوامی API مرکز اور جانچ کے لیے ڈویلپرز کھولیں۔

• پہلی محفوظ درخواست کے لیے Rivya API کا فوری آغاز پڑھیں۔

• سرور پر کلید رکھنے سے پہلے API کی تصدیق پڑھیں۔

• ماڈل شناخت چننے سے پہلے API ماڈلز پڑھیں۔

• اگر مصنوعات کی حد واضح نہیں تو Studio کے بجائے Rivya API کب استعمال کریں پڑھیں۔

• مکمل تصویر، ویڈیو، آڈیو یا چیٹ انضمام کے لیے Rivya API سے کثیر الوسائط طریقۂ کار کیسے بنائیں پڑھیں۔