当前位置：首页 > news >正文

Fish Tasks API 集成与使用指南

news 2026/7/9 12:40:58

简介

Fish Tasks API 的主要功能是通过输入由 Fish Audios Generation API 生成的任务 ID 来查询任务的执行状态。本文将为您提供详细的集成说明，帮助您轻松集成并充分利用此 API 的强大功能。使用 Fish Tasks API，您可以便捷地查询来自 Fish Audios Generation API 的任务执行状态。

环境准备/前置条件

在使用 Fish Tasks API 之前，您需要在 Fish Audios Generation API 申请相应的服务，并从中复制任务 ID，如下图所示：

接下来，访问 Fish Tasks API 页面申请相应的服务。在进入页面后，点击“获取”按钮，如下图所示：

如果您尚未登录或注册，系统将自动重定向到登录页面，邀请您注册并登录。登录或注册后，您将自动返回当前页面。

首次申请者可享受免费的配额，允许您免费使用此 API。

详细步骤

请求示例

Fish Tasks API 可用于查询 Fish Audios Generation API 的结果。有关如何使用 Fish Audios Generation API 的信息，请参阅文档 Fish Videos Generation API。

我们将以 Fish Audios Generation API 返回的任务 ID 为例，演示如何使用此 API。假设我们有一个任务 ID：2725a2d3-f87e-4905-9c53-9988d5a7b2f5，以下是如何传入该任务 ID 的步骤。

设置请求头和请求体

请求头包括：

accept: 指定响应应为 JSON 格式，设置为application/json。
authorization: 调用 API 的密钥，可以在申请后直接选择。

请求体包括：

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, "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://platform.r2.fish.audio/task/b627c2f7d38a4083a837570ba6d0962f.mp3" } ] } }

返回结果包含多个字段，其中request字段为任务发起时的请求体，response字段为任务完成后返回的响应体。

批量查询操作

此操作用于查询多个任务 ID 的任务详情，与前者不同，action需要选择为retrieve_batch。

请求体包括：

ids: 上传的任务 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 '{ "ids": ["2725a2d3-f87e-4905-9c53-9988d5a7b2f5","2725a2d3-f87e-4905-9c53-9988d5a7b2f5"], "action": "retrieve_batch" }'