نظرة عامة على Rivya API

Rivya API v1 هي نقطة دخول المطورين لاستدعاء قدرات نماذج Rivya من منتجك الخاص.

تدعم API العامة توليد الصور والفيديو والصوت بشكل غير متزامن، إضافة إلى دورات Chat API باستجابات غير متدفقة أو ببث SSE. تستخدم معرفات نماذج Rivya، ورصيد حساب Rivya، ومعرفات مهام عامة للتوليد، وجلسات محادثة من جهة الخادم لـ Chat API.

ما الغرض من 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 بدعم بث من جهة الخادم.

المصادقة

تتطلب نقاط نهاية التوليد والحالة والرصيد:

Authorization: Bearer rvya_sk_...

أنشئ المفاتيح ودوّرها من API Keys settings. اقرأ API Authentication قبل استخدام مفتاح في الإنتاج.

نموذج الفوترة

تستخدم استدعاءات API رصيد حساب Rivya نفسه الذي يستخدمه Studio.

تحجز مهام التوليد الرصيد أو تستهلكه عند بدء المهمة. تحجز دورات Chat الرصيد قبل استدعاء النموذج، ثم تسوي الرصيد النهائي من استخدام الرموز عند حفظ رسالة المساعد. إذا فشل توليد أو دورة محادثة وفق قواعد الفشل الحالية في Rivya، ينطبق تعامل الاسترداد نفسه.

اقرأ API Credits وCredits & Billing in Rivya لفهم نموذج المحفظة الموجه للمستخدم.

مسار التكامل الأول

1. أنشئ مفتاح API في الإعدادات.
2. استدع List API Models لاختيار معرف نموذج عام.
3. اقرأ Model API Reference لمعرفة معاملات النموذج.
4. إذا احتاج النموذج إلى وسائط مرجعية، فارفعها باستخدام Files API.
5. أرسل مهمة عبر Create Generation.
6. استطعن Generation Status حتى تنجح المهمة أو تفشل، أو اشترك في API Webhooks لأحداث إكمال موقعة.
7. بالنسبة إلى نماذج المحادثة، استخدم Chat API بدلا من نقطة نهاية التوليد. يجب أن تشير مرفقات صور Chat إلى قيم file_id من Files API.

الصفحات ذات الصلة

• API Quickstart
• API Authentication
• Rivya TypeScript SDK
• Model API Reference
• Chat API
• API Webhooks
• API Errors and Limits