Skip to content

fish_tasks_api_integration_guide.md

Latest commit

 

History

History
67 lines (48 loc) · 2.28 KB

fish_tasks_api_integration_guide.md

File metadata and controls

67 lines (48 loc) · 2.28 KB
Raw

Fish Tasks API Integration and Usage

The main function of the Fish Tasks API is to query the execution status of tasks by inputting the task ID returned by the Fish TTS API.

This document describes the Fish Tasks API integration, helping you query the status and final result of an asynchronous Fish voice generation task.

Application Process

To use the Fish Tasks API, you first need to apply for the corresponding service on the application page Fish TTS API, and then copy the task ID returned by the Fish TTS API.

Finally, go to the Tasks API page Fish Tasks API to apply for the corresponding service. After entering the page, click the "Acquire" button.

There is a free quota available for first-time applicants, allowing you to use this API for free.

Request Example

The Fish Tasks API queries the result of a task created by the Fish TTS API. Create the task with "async": true (or a callback_url), then poll with the returned id.

Request Body

  • id: a single task ID returned by the Fish TTS API.
  • ids: optional array to query multiple tasks at once.
  • action: optional operation type.

Code Example

curl -X POST 'https://api.acedata.cloud/fish/tasks' \
  -H 'accept: application/json' \
  -H 'authorization: Bearer {token}' \
  -H 'content-type: application/json' \
  -d '{
    "id": "8a72ff98-4023-4006-a9f7-4cb2fa04f978"
  }'
import requests

url = "https://api.acedata.cloud/fish/tasks"
headers = {
    "accept": "application/json",
    "authorization": "Bearer {token}",
    "content-type": "application/json",
}
payload = {"id": "8a72ff98-4023-4006-a9f7-4cb2fa04f978"}

response = requests.post(url, json=payload, headers=headers)
print(response.json())

Response Example

{
  "data": {
    "task_id": "8a72ff98-4023-4006-a9f7-4cb2fa04f978",
    "status": "succeeded",
    "audio_url": "https://platform.r2.fish.audio/task/8a72ff9840234006a9f74cb2fa04f978.mp3"
  },
  "success": true
}

Support

If you meet any issue, please check support info or browse the latest documentation on docs.acedata.cloud