Перейти к основному содержанию

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 Get API (GET /fish/model/{id}), который полностью совместим с официальным OpenAPI Fish Audio и предназначен для получения полной информации об одном клонированном тембре по его ID.
Для создания тембра смотрите Fish Model Create API, для постраничного запроса списка — Fish Model Query API.

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

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

​
Отличия от официального API

  • Метод аутентификации: используется Authorization: Bearer {token}, где {token} — это ключ, полученный на нашей платформе.
  • Структура ответа: напрямую передаётся объект ModelEntity из Fish без обёртки платформы; в случае ошибки используется стандартная структура платформы {success:false, error:{code,message}, trace_id}.
  • Параметр пути: {id} — это _id тембра, который возвращается при создании через Fish Model Create API или может быть получен при постраничном запросе через Fish Model Query API.

​
Пример запроса

curl 'https://api.xhuoapi.ai/v1/fish/model/d7900c21663f485ab63ebdb7e5905036' \
  -H 'accept: application/json' \
  -H 'authorization: Bearer {token}'
Достаточно заменить {id} в URL на конкретный ID тембра, никаких дополнительных параметров запроса или тела не требуется.

​
Пример ответа

Успешный ответ содержит напрямую объект 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 может быть использован в дальнейшем в поле reference_id при работе с Fish TTS 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"
}

​
Заключение

Fish Model Get API предоставляет полностью совместимый с официальным Fish Audio интерфейс для получения подробной информации об одном тембре. Получив ID тембра, вы можете с помощью данного API получить полный объект ModelEntity (включая образцы, состояние, видимость, статистику и прочее) и далее использовать Fish TTS API для полного процесса клонирования и синтеза речи.