Перейти до основного вмісту

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.

У цій статті описано інтеграцію Fish Model Query API (GET /fish/model), який повністю сумісний з офіційним OpenAPI Fish Audio і використовується для посторінкового запиту списку клонованих голосів, доступних для поточного облікового запису або всієї платформи.
Для створення голосу дивіться Fish Model Create API, для запиту деталей одного голосу за _id дивіться Fish Model Get API.

​
Процес подачі заявки

Щоб користуватися API, спочатку потрібно подати заявку на відповідний сервіс на сторінці Fish Model API. Після переходу на сторінку натисніть кнопку «Acquire». Якщо ви ще не увійшли або не зареєстровані, вас автоматично перенаправить на сторінку входу, де можна зареєструватися та увійти. Після входу ви автоматично повернетесь на цю сторінку. При першій подачі заявки надається безкоштовний ліміт, що дозволяє безкоштовно користуватися цим API.

​
Відмінності від офіційного API

  • Метод автентифікації: використовується Authorization: Bearer {token}, де {token} — це ключ, отриманий на цій платформі.
  • Структура відповіді: безпосередньо передається посторінкова відповідь Fish без обгортки платформи; у разі помилки використовується стандартна структура платформи {success:false, error:{code,message}, trace_id}.

​
Приклад запиту

curl -G 'https://api.xhuoapi.ai/v1/fish/model' \
  -H 'accept: application/json' \
  -H 'authorization: Bearer {token}' \
  --data-urlencode 'page_size=10' \
  --data-urlencode 'page_number=1' \
  --data-urlencode 'self=true'

​
Параметри запиту

Ідентичні офіційному Fish API:
  • page_size: кількість елементів на сторінку, за замовчуванням 10.
  • page_number: номер сторінки, починаючи з 1.
  • title: пошук за назвою з нечітким співпадінням.
  • tag: фільтрація за тегом.
  • self: якщо передати true, повертаються лише голоси, створені поточним обліковим записом.
  • author_id: фільтрація за автором.
  • language: фільтрація за мовою голосу.
  • title_language: фільтрація за мовою назви.

​
Приклад відповіді

Успішна відповідь безпосередньо передає посторінкову структуру платформи Fish: 
{
  "items": [
    {
      "_id": "d7900c21663f485ab63ebdb7e5905036",
      "title": "我的克隆音色",
      "description": "用一段播客录音克隆的音色",
      "cover_image": "https://example.com/cover.png",
      "type": "tts",
      "state": "trained",
      "tags": [],
      "languages": ["zh", "en"],
      "visibility": "private",
      "created_at": "2025-05-09T12:34:56.789Z",
      "updated_at": "2025-05-09T12:34:56.789Z"
    }
  ],
  "total": 1
}
Повернений _id можна використовувати як значення поля reference_id у подальшому Fish TTS API для синтезу мовлення з цим клонованим голосом.

​
Інформація про тарифи

Цей інтерфейс не тарифікується — посторінковий запит списку голосів є безкоштовною операцією. Лише POST /fish/model з полем voices у тілі запиту для створення нового голосу тарифікується.

​
Обробка помилок

  • 400 token_mismatched: відсутні або некоректні параметри запиту.
  • 400 api_not_implemented: поточний метод або параметри не підтримуються.
  • 401 invalid_token: відсутня або недійсна інформація автентифікації.
  • 429 too_many_requests: перевищено ліміт швидкості для поточного облікового запису.
  • 500 api_error: внутрішня помилка сервера.

​
Приклад відповіді з помилкою

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

​
Висновок

Fish Model Query API забезпечує повністю сумісний з офіційним Fish Audio інструмент для пошуку голосів, що дозволяє підтримувати власну бібліотеку клонованих голосів на цій платформі. У поєднанні з Fish Model Get API можна отримати повні деталі окремого голосу за його ID.