Rivya API

ابنِ فوق طبقة نماذج Rivya متعددة الوسائط

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

شكل البدء السريع

طبقة النماذج

كتالوج ديناميكي

الفوترة

أرصدة مشتركة

الإصدار الأول

مهام + Chat

الوصول

مفاتيح API

الطريقةPOST
نقطة النهاية/api/v1/generations

يتطلب الطلب الحقيقي مفتاح 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": 20,
  "result": null,
  "error": null
}

ما الذي يصل أولًا

طبقة API عامة تبقى متوافقة مع منتج Rivya

صُممت API كسطح من أسطح منتج Rivya. تستخدم معرّفات نماذج Rivya، وأرصدة Rivya، وحالات المهام العامة، ووثائق متصلة بكتالوج النماذج.

واجهة API لتوليد الصور

أرسل مهام صور بالموجّه ومعاملات النموذج المدعومة، ثم استعلم عن النتائج العامة.

واجهة API لتوليد الفيديو

شغّل مهام فيديو غير متزامنة بعناصر تحكم المهام والأرصدة نفسها المستخدمة في Studio.

واجهة API لتوليد الصوت

استخدم نماذج الصوت المتاحة عبر API من خلال حدود الحساب والرصيد والسجل نفسها.

محفظة أرصدة مشتركة

تسحب استدعاءات API واستخدام Studio من رصيد Rivya نفسه، مع أرصدة محجوزة ومعالجة لحالات الفشل.

مسار البدء

من الحساب إلى أول طلب API

01

أنشئ مفتاحًا

سجّل الدخول، وافتح API Keys في الإعدادات، وأنشئ مفتاحًا محدد النطاق، واحفظ السر الكامل فورًا.

02

اختر نموذجًا

اقرأ مرجع نماذج API أو استدعِ /api/v1/models لفحص معرّفات النماذج والمعاملات وقدرات الدردشة وجاهزية الإدخال قبل الإرسال.

03

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

أرسل طلب إنشاء idempotent، أو استعلم عن نقطة نهاية المهمة العامة، أو استخدم webhooks موقّعة لاستقبال callbacks الإنشاء، أو أرسل دور Chat API مع بث SSE اختياري.

حدود الإصدار

نطاق واضح، بلا وعود مخفية

يمكن لصفحة الهبوط أن تذكر أسطحًا مستقبلية، لكن النص الحالي للمنتج يجب ألا يوحي بأن APIs غير المكتملة أصبحت حية بالفعل.

Chat API

متاح

متاحة لأدوار غير متدفقة وأدوار SSE streaming، مع جلسات منشأة عبر API وأرصدة حساب ومرفقات صور اختيارية عبر Files API.

Files API

متاح

متاحة لرفع الصور والفيديو والصوت المرجعي. استخدمها قبل الإنشاء عندما تطلب صفحة النموذج params.referenceMediaItems.

Webhooks المستخدم

متاح

متاحة للتكاملات الإنتاجية التي تريد callbacks موقّعة لمهام الإنشاء الناجحة أو الفاشلة.

المصحح عبر الإنترنت

عاين الطلب، ثم شغّله بمفتاح API الخاص بك

يبدأ المصحح في وضع mock لكل زائر. يسرد محدد الإنشاء النماذج غير المخصصة للدردشة التي يمكن اختبارها دون رفع ملفات، بينما تتيح لوحة Files للمستخدمين المسجلين اختبار /api/v1/files بمفتاح API مؤقت. توجد أمثلة Chat في وثائق API.

حالة الحساب

جارٍ فحص الحساب

بادئة المفتاح النشط

أنشئ مفتاحًا أولًا

الأرصدة الحالية

سجّل الدخول للفحص

معاينة MockPublic API حيلا يوجد مفتاح API نشط

وضع Mock لا يستدعي أي نموذج ولا يستهلك أرصدة.

الصق المفتاح لهذا الطلب فقط. لا يحتفظ به المصحح بعد التحديث.

اختبار رفع Files API

ارفع وسائط مرجعية عبر POST /api/v1/files، ثم انسخ URL وduration token العائدين إلى params.referenceMediaItems لنموذج يدعم المدخلات المرجعية.

Mock لا يرفع الملفاتالحي يستخدم /api/v1/files

يتحكم النموذج المحدد في أنواع MIME المسموحة والحجم وقواعد المدة. تتطلب عمليات الرفع الحية مفتاح API المؤقت الخاص بك وقد تستدعي خدمة الرفع الحقيقية.

إنشاء مفتاح APIقراءة وثائق 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
}
استجابة Files API
{
  "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"
      }
    ]
  }
}

حالة المهمة

الأرصدة الأساسية المقدّرة

1

الحالة

queued

وثائق API

اقرأ عن المصادقة، وأجسام الطلبات، والاستجابات، وidempotency، ومعاملات النماذج، وأكواد الأخطاء.

فتح الوثائق

إدارة مفاتيح API

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

إدارة المفاتيح

التصحيح عبر الإنترنت

استخدم أمثلة mock أولًا؛ يتطلب التصحيح الحقيقي تسجيل الدخول ومفتاح API وأرصدة حساب.

معاينة التدفق