Integración y uso de la API de Fish Tasks

La principal función de la API de Fish Tasks es consultar el estado de ejecución de una tarea mediante el ID de tarea generado por la API de Fish Audios Generation. Este documento detallará las instrucciones de integración de la API de Fish Tasks, ayudándole a integrar y aprovechar al máximo las potentes funciones de esta API. A través de la API de Fish Tasks, puede consultar fácilmente el estado de ejecución de las tareas de la API de Fish Audios Generation.

Proceso de solicitud

Para utilizar la API de Fish Tasks, primero debe ir a la página de solicitud Fish Audios Generation API para solicitar el servicio correspondiente, y luego copiar el ID de tarea de la API de Fish Audios Generation, como se muestra en la imagen:

Finalmente, acceda a la página de Tasks API Fish Tasks API para solicitar el servicio correspondiente. Una vez en la página, haga clic en el botón “Acquire”, como se muestra en la imagen: Si aún no ha iniciado sesión o registrado, será redirigido automáticamente a la página de inicio de sesión para invitarle a registrarse e iniciar sesión. Después de registrarse e iniciar sesión, será redirigido automáticamente a la página actual. En la primera solicitud, se le otorgará un crédito gratuito, que le permitirá utilizar esta API de forma gratuita.

Ejemplo de solicitud

La API de Fish Tasks se puede utilizar para consultar los resultados de la API de Fish Audios Generation. Para obtener información sobre cómo utilizar la API de Fish Audios Generation, consulte el documento Fish Videos Generation API. Tomaremos como ejemplo un ID de tarea devuelto por el servicio de la API de Fish Audios Generation. Supongamos que tenemos un ID de tarea: 2725a2d3-f87e-4905-9c53-9988d5a7b2f5, a continuación, se demostrará cómo utilizar esta API pasando un ID de tarea.

Ejemplo de tarea

Configuración de encabezados de solicitud y cuerpo de solicitud

Request Headers incluye:

accept: especifica que se aceptan respuestas en formato JSON, aquí se debe completar como application/json.
authorization: la clave para llamar a la API, que puede seleccionarse directamente después de la solicitud.

Request Body incluye:

id: el ID de tarea cargado.
action: el método de operación sobre la tarea.

La configuración es como se muestra en la imagen:

Ejemplo de código

Se puede observar que en el lado derecho de la página ya se han generado automáticamente códigos en varios lenguajes, como se muestra en la imagen:

Algunos ejemplos de código son los siguientes:

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"
}'

Ejemplo de respuesta

Después de una solicitud exitosa, la API devolverá la información detallada de la tarea aquí. Por ejemplo:

{
  "_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": "un gato siamés blanco",
    "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"
      }
    ]
  }
}

El resultado devuelto tiene varios campos, el campo request es el cuerpo de la solicitud al iniciar la tarea, mientras que el campo response es el cuerpo de respuesta devuelto una vez que la tarea se completa. La descripción de los campos es la siguiente.

id, el ID que generó esta tarea, utilizado para identificar de manera única esta tarea generada.
request, información de solicitud en la consulta de la tarea.
response, información de respuesta en la consulta de la tarea.

Operación de consulta por lotes

Esto es para consultar los detalles de varias tareas ID, a diferencia de lo anterior, se debe seleccionar la acción como retrieve_batch. Request Body incluye:

ids: un array de IDs de tarea cargados.
action: el método de operación sobre la tarea.

La configuración es como se muestra en la imagen:

Ejemplo de código

Se puede observar que en el lado derecho de la página ya se han generado automáticamente códigos en varios lenguajes, como se muestra en la imagen:

Algunos ejemplos de código son los siguientes:

Ejemplo de respuesta

Después de una solicitud exitosa, la API devolverá la información detallada de todas las tareas en lote. Por ejemplo:

{
  "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,
      "credential_id": "881ad87d-8ba7-40b7-ac45-d19e41ae6e3a",
      "request": {
        "action": "speech",
        "prompt": "un gato siamés blanco",
        "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"
          }
        ]
      }
    },
    {
      "_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": "un gato siamés blanco",
        "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"
          }
        ]
      }
    }
  ],
  "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：Solicitud incorrecta, posiblemente debido a parámetros faltantes o inválidos.
400 api_not_implemented：Solicitud incorrecta, posiblemente debido a parámetros faltantes o inválidos.
401 invalid_token：No autorizado, token de autorización inválido o faltante.
429 too_many_requests：Demasiadas solicitudes, ha superado el límite de tasa.
500 api_error：Error interno del servidor, algo salió mal en el servidor.

错误响应示例

{
  "success": false,
  "error": {
    "code": "api_error",
    "message": "la recuperación falló"
  },
  "trace_id": "2cf86e86-22a4-46e1-ac2f-032c0f2a4e89"
}

结论

通过本文档，您已经了解了如何使用 Fish Tasks API 进行查询单个或批量任务的所有具体详情信息。希望本文档能帮助您更好地对接和使用该 API。如有任何问题，请随时联系我们的技术支持团队。

Primeros pasos

Chat de IA

Imagen de IA

Video de IA

Audio de IA

Web y datos

CAPTCHA

Identidad

Proxy

Avanzado

Integración y uso de la API de Fish Tasks

Proceso de solicitud

Ejemplo de solicitud

Ejemplo de tarea

Configuración de encabezados de solicitud y cuerpo de solicitud

Ejemplo de código

CURL

Ejemplo de respuesta

Operación de consulta por lotes

Ejemplo de código

Ejemplo de respuesta

CURL

错误处理

错误响应示例

结论

​Proceso de solicitud

​Ejemplo de solicitud

​Ejemplo de tarea

​Configuración de encabezados de solicitud y cuerpo de solicitud

​Ejemplo de código

​CURL

​Ejemplo de respuesta

​Operación de consulta por lotes

​Ejemplo de código

​Ejemplo de respuesta

​CURL

​错误处理

​错误响应示例

​结论

Proceso de solicitud

Ejemplo de solicitud

Ejemplo de tarea

Configuración de encabezados de solicitud y cuerpo de solicitud

Ejemplo de código

CURL

Ejemplo de respuesta

Operación de consulta por lotes

Ejemplo de código

Ejemplo de respuesta

CURL

错误处理

错误响应示例

结论