Процесс получения доступа
Чтобы использовать Fish Audios Generation API, сначала получите ваш API Token в консоли Ace Data Cloud и сохраните его для дальнейшего использования.
Если вы еще не вошли в систему или не зарегистрировались, вы будете автоматически перенаправлены на страницу входа, где вам будет предложено зарегистрироваться и войти в систему; после завершения вы автоматически вернетесь на текущую страницу.
Один 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, после получения его можно выбрать напрямую из выпадающего списка.
id: ID загруженной задачи.action: способ операции над задачей.
Пример кода
Можно заметить, что в правой части страницы автоматически сгенерирован код на различных языках, как показано на рисунке:
CURL
Пример ответа
После успешного запроса API вернет подробную информацию о данной задаче. Например:request является request body при создании задачи, в то время как поле response является response body, возвращаемым после завершения задачи. Описание полей приведено ниже.
id— ID, сгенерированный для этой задачи, используется для уникальной идентификации данной задачи генерации.request— информация запроса в задаче запроса.response— информация ответа в задаче запроса; при окончательном успехе содержащийся в немcost.amountпредставляет собой Credits, фактически списанные за данный синтез.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 включает подробную информацию о пакетных задачах, а подробная информация о каждой задаче содержит те же поля, что и выше. Информация о полях приведена ниже.
items— вся подробная информация о пакетных задачах. Это массив, каждый элемент которого имеет такой же формат, как результат возврата при запросе одной задачи выше.count— количество задач в данном пакетном запросе.
CURL
Обработка ошибок
При вызове API, если возникает ошибка, API возвращает соответствующий код ошибки и сообщение. Например:400 token_mismatched: Некорректный запрос, возможно, из-за отсутствующих или недействительных параметров.400 api_not_implemented: Некорректный запрос, возможно, из-за отсутствующих или недействительных параметров.401 invalid_token: Не авторизован, недействительный или отсутствующий токен авторизации.429 too_many_requests: Слишком много запросов, вы превысили лимит скорости.500 api_error: Внутренняя ошибка сервера, что-то пошло не так на сервере.