Интеграция и использование Fish Tasks API

Основная функция Fish Tasks API заключается в том, чтобы запрашивать статус выполнения задачи, используя ID задачи, сгенерированный Fish Audios Generation API. В этом документе подробно описывается интеграция Fish Tasks API, чтобы помочь вам легко интегрировать и в полной мере использовать мощные возможности этого API. С помощью Fish Tasks API вы можете легко реализовать запрос статуса выполнения задач Fish Audios Generation API.

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

Чтобы использовать Fish Audios Generation API, сначала перейдите в консоль Ace Data Cloud и получите ваш API Token для резервного копирования.

Если вы еще не вошли в систему или не зарегистрированы, вы будете автоматически перенаправлены на страницу входа, где вас пригласят зарегистрироваться и войти. После завершения вы будете автоматически возвращены на текущую страницу. Один API Token позволяет вызывать все сервисы платформы, не нужно отдельно запрашивать для каждого сервиса. При первом запросе предоставляется бесплатный лимит, чтобы вы могли попробовать; при недостатке лимита вы можете пополнить общий баланс в консоли.

📘 Полная документация: Fish Audios Generation API →

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

Fish Tasks API можно использовать для запроса результатов Fish Audios Generation API. Для получения информации о том, как использовать Fish Audios Generation API, пожалуйста, обратитесь к документации Fish Videos Generation API. Мы возьмем один из ID задач, возвращаемых сервисом Fish Audios Generation API, в качестве примера, чтобы продемонстрировать, как использовать этот API. Предположим, у нас есть ID задачи: 2725a2d3-f87e-4905-9c53-9988d5a7b2f5, далее мы покажем, как передать этот ID задачи.

Пример задачи

Установка заголовков запроса и тела запроса

Request Headers включает:

accept: указывает на прием ответа в формате JSON, здесь указывается application/json.
authorization: ключ для вызова API, после запроса можно выбрать из выпадающего списка.

Request Body включает:

id: загруженный ID задачи.
action: способ выполнения операции над задачей.

Настройка, как показано на рисунке ниже:

Пример кода

Можно заметить, что на правой стороне страницы автоматически сгенерирован код на различных языках, как показано на рисунке:

Некоторые примеры кода:

CURL

curl -X POST 'https://api.acedata.cloud/fish/tasks' \
-H 'accept: application/json' \
-H 'authorization: Bearer {token}' \
-H 'content-type: application/json' \
-d '{
  "id": "2725a2d3-f87e-4905-9c53-9988d5a7b2f5",
  "action": "retrieve"
}'

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

После успешного запроса API вернет информацию о деталях этой задачи. Например:

{
  "_id": "68cfad98550a4144a5476a92",
  "id": "2725a2d3-f87e-4905-9c53-9988d5a7b2f5",
  "api_id": "8e6f8083-4683-45fe-a993-3e1d993fc999",
  "application_id": "3559d836-2505-46be-96ea-ea72bcb7c080",
  "created_at": 1758440856.34,
  "started_at": 1758440856.4,
  "finished_at": 1758440869.2,
  "elapsed": 12.8,
  "credential_id": "881ad87d-8ba7-40b7-ac45-d19e41ae6e3a",
  "request": {
    "action": "speech",
    "prompt": "a white siamese cat",
    "model": "fish-tts",
    "voice_id": "d7900c21663f485ab63ebdb7e5905036",
    "callback_url": "https://webhook.site/4815f79f-a40f-4078-ac85-1cc126b6bb34"
  },
  "trace_id": "e2d308bc-4df8-4c69-9369-a60f3c54f2b3",
  "type": "audios",
  "user_id": "ad7afe47-cea9-4cda-980f-2ad8810e51cf",
  "response": {
    "success": true,
    "task_id": "2725a2d3-f87e-4905-9c53-9988d5a7b2f5",
    "trace_id": "e2d308bc-4df8-4c69-9369-a60f3c54f2b3",
    "data": [
      {
        "audio_url": "https://platform2.cdn.acedata.cloud/fish/5ade0339-5f11-487e-aacc-06a908271706.mp3"
      }
    ]
  }
}

Возвращаемый результат содержит несколько полей, поле request — это request body, отправленный при создании задачи, а поле response — это response body, возвращаемый после завершения задачи. Описание полей:

id: ID, сгенерированный для этой задачи, используется для уникальной идентификации данной задачи.
request: информация о запросе в задаче.
response: информация о возвращаемом ответе в задаче; в случае успешного выполнения cost.amount — это фактически списанные кредиты.
created_at: время создания задачи, Unix timestamp (секунды, с плавающей точкой).
started_at: время начала выполнения задачи, Unix timestamp (секунды, с плавающей точкой).
finished_at: время завершения задачи, Unix timestamp (секунды, с плавающей точкой). Это поле не возвращается, если задача не завершена.
elapsed: время выполнения задачи, в секундах (с плавающей точкой, с 3 знаками после запятой). Это поле не возвращается, если задача не завершена.

Пакетный запрос

Это запрос для получения деталей нескольких ID задач, в отличие от предыдущего, здесь необходимо выбрать action как retrieve_batch. Request Body включает:

ids: массив загруженных ID задач.
action: способ выполнения операции над задачей.

Настройка, как показано на рисунке ниже:

Пример кода

Некоторые примеры кода:

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

После успешного запроса API вернет конкретные детали всех пакетных задач. Например:

{
  "items": [
    {
      "_id": "68cfad98550a4144a5476a92",
      "id": "2725a2d3-f87e-4905-9c53-9988d5a7b2f5",
      "api_id": "8e6f8083-4683-45fe-a993-3e1d993fc999",
      "application_id": "3559d836-2505-46be-96ea-ea72bcb7c080",
      "created_at": 1758440856.34,
      "started_at": 1758440856.4,
      "finished_at": 1758440869.2,
      "elapsed": 12.8,
      "credential_id": "881ad87d-8ba7-40b7-ac45-d19e41ae6e3a",
      "request": {
        "action": "speech",
        "prompt": "белый сиамский кот",
        "model": "fish-tts",
        "voice_id": "d7900c21663f485ab63ebdb7e5905036",
        "callback_url": "https://webhook.site/4815f79f-a40f-4078-ac85-1cc126b6bb34"
      },
      "trace_id": "e2d308bc-4df8-4c69-9369-a60f3c54f2b3",
      "type": "audios",
      "user_id": "ad7afe47-cea9-4cda-980f-2ad8810e51cf",
      "response": {
        "success": true,
        "task_id": "2725a2d3-f87e-4905-9c53-9988d5a7b2f5",
        "trace_id": "e2d308bc-4df8-4c69-9369-a60f3c54f2b3",
        "data": [
          {
            "audio_url": "https://platform2.cdn.acedata.cloud/fish/5ade0339-5f11-487e-aacc-06a908271706.mp3"
          }
        ]
      }
    },
    {
      "_id": "68cfad98550a4144a5476a92",
      "id": "2725a2d3-f87e-4905-9c53-9988d5a7b2f5",
      "api_id": "8e6f8083-4683-45fe-a993-3e1d993fc999",
      "application_id": "3559d836-2505-46be-96ea-ea72bcb7c080",
      "created_at": 1758440856.34,
      "started_at": 1758440856.4,
      "finished_at": 1758440869.2,
      "elapsed": 12.8,
      "credential_id": "881ad87d-8ba7-40b7-ac45-d19e41ae6e3a",
      "request": {
        "action": "speech",
        "prompt": "белый сиамский кот",
        "model": "fish-tts",
        "voice_id": "d7900c21663f485ab63ebdb7e5905036",
        "callback_url": "https://webhook.site/4815f79f-a40f-4078-ac85-1cc126b6bb34"
      },
      "trace_id": "e2d308bc-4df8-4c69-9369-a60f3c54f2b3",
      "type": "audios",
      "user_id": "ad7afe47-cea9-4cda-980f-2ad8810e51cf",
      "response": {
        "success": true,
        "task_id": "2725a2d3-f87e-4905-9c53-9988d5a7b2f5",
        "trace_id": "e2d308bc-4df8-4c69-9369-a60f3c54f2b3",
        "data": [
          {
            "audio_url": "https://platform2.cdn.acedata.cloud/fish/5ade0339-5f11-487e-aacc-06a908271706.mp3"
          }
        ]
      }
    }
  ],
  "count": 2
}

CURL

curl -X POST 'https://api.acedata.cloud/fish/tasks' \
-H 'accept: application/json' \
-H 'authorization: Bearer {token}' \
-H 'content-type: application/json' \
-d '{
  "ids": ["2725a2d3-f87e-4905-9c53-9988d5a7b2f5","2725a2d3-f87e-4905-9c53-9988d5a7b2f5"],
  "action": "retrieve_batch"
}'

Ошибка обработки

При вызове API, если возникнет ошибка, API вернет соответствующий код ошибки и информацию. Например:

400 token_mismatched：Неверный запрос, возможно, из-за отсутствующих или недействительных параметров.
400 api_not_implemented：Неверный запрос, возможно, из-за отсутствующих или недействительных параметров.
401 invalid_token：Неавторизован, недействительный или отсутствующий токен авторизации.
429 too_many_requests：Слишком много запросов, вы превысили лимит частоты.
500 api_error：Внутренняя ошибка сервера, что-то пошло не так на сервере.

Пример ответа об ошибке

{
  "success": false,
  "error": {
    "code": "api_error",
    "message": "не удалось получить"
  },
  "trace_id": "2cf86e86-22a4-46e1-ac2f-032c0f2a4e89"
}

Заключение

С помощью этого документа вы узнали, как использовать Fish Tasks API для запроса всех конкретных деталей о единичных или пакетных задачах. Надеемся, что этот документ поможет вам лучше интегрировать и использовать этот API. Если у вас есть какие-либо вопросы, пожалуйста, не стесняйтесь обращаться в нашу техническую поддержку.

Начало работы

AI Чат

AI Изображение

AI Видео

AI Аудио

Веб и данные

CAPTCHA

Идентичность

Прокси

Продвинутый

Coding

Интеграция и использование Fish Tasks API

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

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

Пример задачи

Установка заголовков запроса и тела запроса

Пример кода

CURL

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

Пакетный запрос

Пример кода

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

CURL

Ошибка обработки

Пример ответа об ошибке

Заключение

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

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

​Пример задачи

​Установка заголовков запроса и тела запроса

​Пример кода

​CURL

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

​Пакетный запрос

​Пример кода

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

​CURL

​Ошибка обработки

​Пример ответа об ошибке

​Заключение

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

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

Пример задачи

Установка заголовков запроса и тела запроса

Пример кода

CURL

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

Пакетный запрос

Пример кода

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

CURL

Ошибка обработки

Пример ответа об ошибке

Заключение