↓
وثائق Rivya AI

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

استخدم Rivya API v1 لاستدعاء نماذج التوليد والمحادثة في Rivya من منتجك الخاص باستخدام مفاتيح API، ورصيد الحساب، وبث SSE الاختياري.

آخر مراجعة في 2026/08/29

Rivya API v1 هو عقد المطورين لاستدعاء إمكانات نماذج Rivya المدعومة من منتجك، عندما يكون الوصول إلى API العام مفعلا للنشر ومتوفرا لحسابك.

يغطي العقد المنفذ توليد الصور والفيديو والصوت بصورة غير متزامنة، إضافة إلى دورات المحادثة عبر API باستجابات عادية أو بث SSE. ويستخدم معرفات نماذج 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

يتضمن العقد الحالي ويبهوكات موقعة لنتائج التوليد غير المتزامنة، وواجهة API للمحادثة، وإصدارا تجريبيا من TypeScript SDK بدعم بث من جهة الخادم. تتطلب استدعاءات الويبهوك تفعيل ميزة الويبهوك وإتاحة واجهة API العامة لهذا النشر.

المصادقة

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

Authorization: Bearer rvya_sk_...

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

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

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

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

اقرأ أرصدة API والأرصدة والفوترة في Rivya لفهم نموذج المحفظة الموجه للمستخدم.

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

  1. أنشئ مفتاح API في الإعدادات.

  2. استدع عرض نماذج API لاختيار معرف نموذج عام.

  3. اقرأ مرجع API للنماذج لمعرفة معاملات النموذج.

  4. إذا احتاج النموذج إلى وسائط مرجعية، فارفعها باستخدام واجهة API للملفات.

  5. أرسل مهمة عبر إنشاء عملية توليد.

  6. استطلع حالة التوليد حتى تنجح المهمة أو تفشل. إذا كانت الويبهوكات مفعلة للنشر والحساب، فيمكنك بدلا من ذلك الاشتراك عبر إشعارات Webhook عبر API لتلقي أحداث إكمال موقعة.

  7. بالنسبة إلى نماذج المحادثة، استخدم واجهة API للمحادثة بدلا من نقطة نهاية التوليد. ويجب أن تشير مرفقات الصور إلى قيم file_id من واجهة API للملفات.

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

نماذج Rivya: ما الذي يمكنك استخدامه الآن؟

تحقق من حالة نموذج Rivya ومتطلبات الإدخال في Studio وAPI، واختر بديلاً مناسباً قبل إنفاق الرصيد.

البدء السريع مع Rivya API

أنشئ مفتاح API، واختر نموذجا، وأرسل مهمة توليد غير متزامنة، ثم أرسل دورة محادثة عبر API مع بث SSE اختياري.

جدول المحتويات

ما الغرض من API
نطاق الإصدار الحالي
المصادقة
نموذج الفوترة
مسار التكامل الأول
الصفحات ذات الصلة