مرجع API
Fish Audio افتح مرجع نقطة النهاية API.
مرجع API
تُعد Fish Audio Open API واجهة من جانب الخادم لسير عمل الإنتاج الصوتي. استخدمه عندما يحتاج منتجك إلى تحويل النص إلى كلام، أو تحويل الكلام إلى نص، أو إدارة الصوت، أو أتمتة مزامنة الشفاه دون الاعتماد على وحدة تحكم الويب.
عنوان URL الأساسي:
https://fishaudio.org/api/open/v1المصادقة:
Authorization: Bearer FISHAUDIO_API_KEYمخطط قابل للقراءة آليًا:
GET /api/openapi.jsonالأسطح العامة الحالية
| السطح | حالة API الحالية في الخارج | مستندات |
|---|---|---|
| الملف الشخصي | نقطة نهاية v1 عامة لفحوصات الحساب والطبقة والائتمانات والحصة | الملف الشخصي |
| النص إلى كلام | المزامنة العامة HTTP ونقاط نهاية المهمة غير المتزامنة | مزامنة HTTP، الوظائف غير المتزامنة |
| الوقت الحقيقي TTS | يتم التحكم في التوفر من خلال الحساب وطرح المنتج | الوقت الحقيقي TTS |
| الكلام إلى نص | نقطة نهاية النسخ العامة HTTP | تحويل الكلام إلى نص |
| الوقت الحقيقي ASR | يتم التحكم في التوفر من خلال الحساب وطرح المنتج | الوقت الحقيقي ASR |
| صور | صفحة قدرة المنتج؛ يعتمد توفر نقطة النهاية العامة على المخطط | الصور |
| فيديوهات | صفحة قدرة المنتج؛ يعتمد توفر نقطة النهاية العامة على المخطط | فيديوهات |
| إدارة الصوت | افتح نقاط نهاية API لإدراج النماذج الصوتية وإنشائها وحذفها | إدارة الصوت |
| مزامنة الشفاه | نقاط نهاية مهمة عامة غير متزامنة للفيديو المصدر بالإضافة إلى سير عمل الصوت | مزامنة الشفاه |
| الاستخدام | إرشادات استخدام الحساب؛ استخدم ملف التعريف اليوم والمخطط لنقاط نهاية الاستخدام الجديدة | الاستخدام |
نموذج الطلب
يجب أن تتم جميع الطلبات من الخادم الخاص بك. يجب على عملاء المتصفح وتطبيقات الهاتف المحمول الاتصال بالواجهة الخلفية الخاصة بك أولاً، ثم تستدعي الواجهة الخلفية Open API باستخدام المفتاح API.
curl https://fishaudio.org/api/open/v1/profile \
-H "Authorization: Bearer FISHAUDIO_API_KEY"استخدم JSON لمعظم نقاط النهاية. قد يستخدم إنشاء الصوت بيانات نموذج متعددة الأجزاء عندما يطلب الموفر الممكّن صوتًا مرجعيًا. يتم استخدام الاستجابات الصوتية الثنائية من خلال مزامنة TTS عندما تطلب صوتًا مباشرًا بدلاً من بيانات التعريف المخزنة مؤقتًا.
نموذج الاستجابة
الاستجابات الناجحة خاصة بنقطة النهاية. تقوم نقاط النهاية غير المتزامنة بإرجاع كائنات المهمة أو المهمة التي يجب على التطبيق الخاص بك استقصائها حتى يتم الوصول إلى حالة المحطة الطرفية. قد تقوم نقاط نهاية وسائط المزامنة بإرجاع بيانات ثنائية أو بيانات تعريف JSON وفقًا لخيارات الطلب.
تستخدم الأخطاء نص JSON:
{
"code": "invalid_request",
"message": "The request payload is invalid.",
"requestId": "req_xxx"
}قم بتسجيل requestId عندما يكون موجودًا. إنها أسرع طريقة للدعم لتتبع الطلب الفاشل.
الفواتير والائتمانات
تستهلك مكالمات API المفتوحة أرصدة الحساب أو حصة API وفقًا لنقطة النهاية والنموذج الممكّن. يتم شحن بعض نقاط النهاية عند قبول المهمة؛ والبعض الآخر يتقاضى رسومًا عندما ينجح جيل الوسائط. يجب أن يعرض التكامل الخاص بك حالة إعادة محاولة واضحة ويجب ألا يفترض أن كل طلب فاشل يكلف أرصدة.
بالنسبة لعمليات سير العمل الحساسة للتوازن، اتصل بـ الملف التعريفي قبل بدء دفعات كبيرة وبعد اكتمال المهام المهمة. يجب أيضًا أن تستمر المهام طويلة الأمد في معرف المهمة الذي تم إرجاعه حتى تتمكن من التعافي من عمليات إعادة تشغيل العميل دون إنشاء عمل مكرر.
التوافق
تظل مسارات API المفتوحة القديمة متاحة أثناء نافذة التوافق، ولكن يجب أن تستخدم عمليات التكامل الجديدة /api/open/v1. يسرد دليل الترحيل بدائل المسار المعروفة وترتيب الطرح.
تستخدم المستندات الخارجية مساراتها الحالية عن عمد. إذا كنت تقوم بدمج الموقع العالمي، فاتبع المسارات الموجودة ضمن https://fishaudio.org/api/open/v1 وقم بتأكيد الأسطح الجديدة باستخدام GET /api/openapi.json.