Інтеграція та використання 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 - це тіло запиту, яке було надіслано під час створення завдання, а поле response - це тіло відповіді, яке повертається після завершення завдання. Ось опис полів.

id, ID, що генерує це завдання, використовується для унікальної ідентифікації цього завдання.
request, інформація про запит у завданні.
response, інформація про відповідь у завданні; в кінцевому успішному випадку cost.amount є фактично знятою кількістю кредитів.
created_at, час створення завдання, Unix-час (секунди, з плаваючою комою).
started_at, час початку виконання завдання, Unix-час (секунди, з плаваючою комою).
finished_at, час завершення завдання, Unix-час (секунди, з плаваючою комою). Це поле не повертається, якщо завдання не завершено.
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
}

返回结果一共有多个字段，其中items是包含了批量任务的具体详情信息，每个任务的具体信息与上文的字段一样，字段信息如下。

items，批量任务的所有具体详情信息。它 є масив, кожен елемент масиву має таку ж структуру, як і результат запиту одного завдання.
count，кількість завдань у цьому запиті.

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. Якщо у вас є будь-які питання, будь ласка, звертайтеся до нашої технічної підтримки.

Getting Started

AI Чат

AI Зображення

AI Відео

AI Аудіо

Веб і дані

CAPTCHA

Ідентичність

Проксі

Advanced

Coding

Інтеграція та використання Fish Tasks API

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

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

Приклад завдання

Налаштування заголовків запиту та тіла запиту

Приклад коду

CURL

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

Пакетний запит

Приклад коду

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

CURL

Помилка обробки

Приклад відповіді на помилку

Висновок

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

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

​Приклад завдання

​Налаштування заголовків запиту та тіла запиту

​Приклад коду

​CURL

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

​Пакетний запит

​Приклад коду

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

​CURL

​Помилка обробки

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

​Висновок

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

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

Приклад завдання

Налаштування заголовків запиту та тіла запиту

Приклад коду

CURL

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

Пакетний запит

Приклад коду

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

CURL

Помилка обробки

Приклад відповіді на помилку

Висновок