الانتقال إلى المحتوى الرئيسي

Documentation Index

Fetch the complete documentation index at: https://docs.xhuoapi.ai/llms.txt

Use this file to discover all available pages before exploring further.

سيتم تقديم شرح لدمج API الحصول على نموذج السمك (GET /fish/model/{id})، والذي يتوافق تمامًا مع واجهة برمجة التطبيقات الرسمية لـ Fish Audio OpenAPI، ويستخدم لـ الاستعلام عن تفاصيل كاملة لنموذج صوت استنساخ فردي باستخدام معرف الصوت.
لإنشاء نموذج صوت يرجى الرجوع إلى API إنشاء نموذج السمك، وللبحث في قائمة الصفحات يرجى الرجوع إلى API استعلام نموذج السمك.

​
عملية التقديم

لاستخدام API، يجب أولاً التقديم على الخدمة المقابلة في صفحة API نموذج السمك. بعد الدخول إلى الصفحة، اضغط على زر “Acquire”. إذا لم تكن قد سجلت الدخول أو أنشأت حسابًا، سيتم إعادة التوجيه تلقائيًا إلى صفحة تسجيل الدخول لدعوتك للتسجيل وتسجيل الدخول، وبعد تسجيل الدخول ستعود تلقائيًا إلى الصفحة الحالية. في الطلب الأول، سيتم منح حصة مجانية يمكنك استخدامها مجانًا لهذا API.

​
الاختلافات مع API الرسمي

  • طريقة المصادقة: تستخدم Authorization: Bearer {token}، حيث أن {token} هو المفتاح الذي تم التقديم عليه في المنصة.
  • هيكل الاستجابة: يتم تمرير كائن ModelEntity من منصة Fish مباشرة دون تغليف من خلال envelop؛ في حالة الخطأ، يتم استخدام الهيكل القياسي للمنصة {success:false, error:{code,message}, trace_id}.
  • معاملات المسار: {id} هو _id الخاص بالنموذج الصوتي، ويمكن الحصول عليه عند إنشاء النموذج عبر API إنشاء نموذج السمك، أو عند استعلام الصفحات عبر API استعلام نموذج السمك.

​
مثال على الطلب

curl 'https://api.xhuoapi.ai/v1/fish/model/d7900c21663f485ab63ebdb7e5905036' \
  -H 'accept: application/json' \
  -H 'authorization: Bearer {token}'
كل ما عليك هو استبدال {id} في مسار URL بمعرف الصوت المحدد، دون الحاجة إلى أية معلمات استعلام أو جسم طلب.

​
مثال على الاستجابة

الاستجابة الناجحة تمرر مباشرة كائن ModelEntity من منصة Fish: 
{
  "_id": "d7900c21663f485ab63ebdb7e5905036",
  "type": "tts",
  "title": "نموذج الصوت الخاص بي",
  "description": "نموذج صوت مستنسخ من تسجيل بودكاست",
  "cover_image": "https://example.com/cover.png",
  "train_mode": "fast",
  "state": "trained",
  "tags": [],
  "samples": [
    {
      "audio": "https://example.com/sample-voice.mp3",
      "text": ""
    }
  ],
  "created_at": "2025-05-09T12:34:56.789Z",
  "updated_at": "2025-05-09T12:34:56.789Z",
  "languages": ["zh", "en"],
  "visibility": "private",
  "lock_visibility": false,
  "default_text": "",
  "default_mode": "fast",
  "like_count": 0,
  "mark_count": 0,
  "shared_count": 0,
  "task_count": 0,
  "unliked": false,
  "liked": false,
  "marked": false,
  "author": {
    "_id": "00000000000000000000000000000000",
    "nickname": "",
    "avatar": ""
  }
}
返回的 _id 可以作为后续 Fish TTS API 中 reference_id الحقل، لاستخدام هذا النموذج في توليف الصوت.

​
شرح التسعير

هذا API غير مكلف — استعلام تفاصيل النموذج عبر ID هو عملية مجانية، فقط عند إنشاء نموذج جديد باستخدام POST /fish/model مع حقل voices في جسم الطلب يتم فرض رسوم.

​
معالجة الأخطاء

  • 400 token_mismatched: نقص أو عدم صحة معلمات الطلب.
  • 400 api_not_implemented: طريقة الطلب أو المعاملات غير مدعومة حاليًا.
  • 401 invalid_token: نقص أو عدم صحة معلومات المصادقة.
  • 404 not_found: النموذج الصوتي المحدد بـ _id غير موجود أو غير مرئي للحساب الحالي.
  • 429 too_many_requests: تجاوز الحد الأقصى لمعدل الطلبات للحساب الحالي.
  • 500 api_error: خطأ داخلي في الخادم.

​
مثال على استجابة الخطأ

{
  "success": false,
  "error": {
    "code": "api_error",
    "message": "fetch failed"
  },
  "trace_id": "2cf86e86-22a4-46e1-ac2f-032c0f2a4e89"
}

​
الخلاصة

يوفر API الحصول على نموذج السمك القدرة على استعلام تفاصيل نموذج صوت واحد متوافق تمامًا مع منصة Fish Audio. بعد الحصول على معرف النموذج، يمكن استخدام هذا API لجلب كائن ModelEntity كامل (يشمل العينات، الحالة، الرؤية، الإحصائيات، وغيرها)، ثم استخدام API TTS الخاص بـ Fish لإتمام عملية الاستنساخ والتوليف من النهاية إلى النهاية.