مرجع API
توثيق التطبيقات، إنشاء النصوص والصور، إنشاء التضمينات، وأتمتة سير العمل للمزود، الجهاز والمُنشئ.
قم بإجراء أول طلب لواجهة برمجة التطبيقات
قم بإنشاء مفتاح API لـ ShareAI، اختر نموذجًا متاحًا وأرسل طلب دردشة من خادمك باستخدام مصادقة Bearer.
اختر واجهة برمجة التطبيقات المناسبة وبيانات الاعتماد
العثور على نقاط نهاية API الخاصة بـ ShareAI لتوثيق التطبيقات، الدردشة، الردود، التضمينات، الصور، المزودين، الأجهزة والمبدعين، مع عنوان URL الصحيح وبيانات الاعتماد.
سجّل تطبيقك
أنشئ تطبيقًا، اختر نموذج نشره وقم بتمكين فقط القدرات التي يحتاجها من ShareAI.
قم بتفويض حساب باستخدام PKCE
استخدم رمز التفويض مع S256 PKCE للتطبيقات السرية والعامة.
اختر نطاقات تسجيل الدخول والدفع والذكاء الاصطناعي
تسجيل الدخول، مدفوعات المنتجات ورسوم الاستدلال تتطلب قدرات منفصلة وتفويض العميل.
تحديث رمز الوصول
قم بتدوير رموز التحديث دون توسيع نطاقات التفويض المصرح بها للعميل.
قراءة الهوية واكتشاف نقاط نهاية المصادقة
استخدم اكتشاف ShareAI Auth وJWKS وUserInfo للتحقق من تسجيل دخول التطبيق وقراءة الهوية المسموح بها بواسطة رمز وصول OAuth.
إلغاء الرموز وفحص التفويض على الخادم
قم بإلغاء الرموز غير المستخدمة للوصول والتحديث. يمكن للتكاملات السرية أيضًا فحص حالة الرموز.
فهم اتفاقيات الفوترة المقبولة
حافظ على سعر الاشتراك، الفاصل الزمني ورسوم AI مرتبطة بالشروط التي وافق عليها كل عميل.
إنشاء إكمال دردشة
أرسل طلب إكمال محادثة ShareAI باستخدام مفتاح API Bearer وفهم النموذج المدعوم، الرسائل وحقول البث.
إرسال طلبات الدردشة باستخدام OAuth
استخدم رمز وصول OAuth المعتمد من ShareAI لإكمالات المحادثة الممولة من العميل وتعامل مع انتهاء صلاحية الرمز، الموافقة وحدود الحساب.
بث استجابة الدردشة
قراءة أحداث الخادم المرسلة للدردشة ShareAI، إلحاق دلتا المحتوى مرة واحدة ومعالجة الإكمال، الأخطاء والتدفقات المتقطعة.
فحص الوصول الرئيسي وهوية الحساب
اقرأ معلومات مفتاح API الخاص بـ ShareAI للتحقق من قيود النموذج والمزود وهوية الحساب المرتبطة ببيانات الاعتماد الخاصة بالاستدلال.
إنشاء رد نصي
استخدم واجهة برمجة تطبيقات الردود ShareAI لإنشاء نصوص بدون حالة، سجل محادثات صريح وأحداث بث الردود.
إنشاء تضمينات نصية
إنشاء تضمينات نصية باستخدام ShareAI للبحث الدلالي، الاسترجاع والتشابه، مع تنسيقات الإدخال المدعومة ومتطلبات النموذج.
إنشاء صورة
أنشئ صورًا باستخدام ShareAI Images API باستخدام نموذج مدعوم، مطالبة نصية وخيارات إنشاء صور مُعتمدة.
المصادقة على واجهة برمجة التطبيقات للمزود
تمكين الوصول عن بُعد للمزود واستخدام UUID الخاص بالمزود ورمز وصول محدد النطاق لطلبات الكتالوج والتسعير.
قائمة نماذج المزود والشبكة
اقرأ كتالوج شبكة ShareAI Provider API، كتالوج المزود الخاص بك وتفاصيل النموذج الدقيقة باستخدام provider_models:read.
تحديث تسعير نموذج المزود
قم بتعيين مستويات تسعير الإدخال والإخراج والتخزين المؤقت لنموذج مزود ShareAI باستخدام رمز API محدد النطاق ومعرف نموذج دقيق.
المصادقة على واجهة برمجة التطبيقات للجهاز
أنشئ رمز تحكم عن بُعد خاص بالجهاز وافهم فحوصات المزود والجهاز وحالة التمكين لطلبات ShareAI Device API.
قراءة جلسات الجهاز وسجل المهام
قائمة جلسات أجهزة ShareAI وفحص سجل المهام لجلسة باستخدام رمز التحكم عن بعد الخاص بالجهاز.
بدء وإيقاف مشاركة الجهاز
إرسال أوامر مشاركة أجهزة ShareAI، تمييز الأوامر المقبولة عن الحالة الملاحظة والتحقق من النتيجة في Console.
المصادقة على واجهة برمجة التطبيقات للمنشئ
استخدم بيانات اعتماد الوصول عن بُعد المخصصة لـ Creator وفهم نطاقات التجميع والنماذج والإعدادات المتاحة في واجهة برمجة التطبيقات ShareAI Creator API.
قراءة وإدارة مجموعات النماذج
قم بإدراج، إنشاء وتحديث مجموعات نماذج ShareAI Creator مع النطاقات المطلوبة وحدود الملكية والمراجعة الواضحة.
إنشاء حزمة نموذج
إنشاء بيانات تعريف نموذج ShareAI Creator، تجميع وعلامات النموذج معًا، مع سياسة وصول واضحة وأوراق اعتماد API محددة النطاق.
إدارة النماذج داخل مجموعة
أنشئ علامة.
التعامل مع أخطاء واجهة برمجة التطبيقات وإعادة المحاولة
أعد محاولة القراءة بحد.
فهم منشئي النماذج والمعرفات والعلامات
اختر معرف نموذج ShareAI المستند إلى المنشئ بدقة، استكشف عائلته وقارن بين المزودين الذين يمكنهم تشغيله.
اختيار مزودي التنفيذ لطلب API
استخدم كائن مزود ShareAI لاختيار مزودي التنفيذ بشكل مستقل عن منشئ النموذج عبر جميع نقاط النهاية الأربعة للاستدلال.
مرجع سياسة المزود
ارجع إلى حقول ShareAI الخاصة بالمزود، الإعدادات الافتراضية، الحدود والأخطاء لاختيار مزودي التنفيذ في طلبات الاستدلال.
ترتيب المزودين والتحكم في البدائل
فهم تصنيف السعر، زمن الاستجابة ومعدل الإنتاجية في ShareAI، ترتيب المزودين، القياسات غير المتوفرة وحدود التراجع الآمنة.
فهم هويات العملاء
يتلقى كل عميل OAuth معرفًا مختلفًا لنفس عميل ShareAI.
الدفع مقابل المنتجات والاشتراكات
أنشئ عملية دفع عبر المحفظة، دع العميل يؤكدها في ShareAI، ثم تحقق من النتيجة المدفوعة قبل التنفيذ.
معالجة أخطاء الفوترة وحدود إنفاق العملاء
ميّز بين نقص الرصيد وحدود الإنفاق للتطبيق، قدّم رابط استرداد مخصص للمستخدم وتعامل مع فشل البث بشكل صحيح.