Fish Tasks API:s integration och användning

Fish Tasks API:s huvudfunktion är att genom att ange det uppgift-ID som genererats av Fish Audios Generation API för att fråga om statusen för den uppgiften. Detta dokument kommer att detaljerat beskriva integrationen av Fish Tasks API, för att hjälpa dig att enkelt integrera och fullt utnyttja den kraftfulla funktionen hos detta API. Genom Fish Tasks API kan du enkelt fråga om statusen för uppgifter från Fish Audios Generation API.

Ansökningsprocess

För att använda Fish Audios Generation API, börja med att gå till Ace Data Cloud-konsolen för att få din API-token, som du kan spara för framtida bruk.

Om du inte har loggat in eller registrerat dig, kommer du automatiskt att omdirigeras till inloggningssidan där du uppmanas att registrera dig och logga in, och efter att ha slutfört detta kommer du automatiskt att återvända till den aktuella sidan. En API-token räcker för att anropa alla tjänster på plattformen, du behöver inte ansöka separat för varje tjänst. Första ansökan ger en gratis kvot, så att du kan prova gratis; när kvoten är slut kan du ladda på allmän balans i konsolen.

📘 Fullständig dokumentation: Fish Audios Generation API →

Begärningsexempel

Fish Tasks API kan användas för att fråga om resultaten från Fish Audios Generation API. För information om hur man använder Fish Audios Generation API, se dokumentationen Fish Videos Generation API. Vi tar ett exempel med ett uppgift-ID som returnerats av Fish Audios Generation API, för att demonstrera hur man använder detta API. Anta att vi har ett uppgift-ID: 2725a2d3-f87e-4905-9c53-9988d5a7b2f5, och vi visar hur man gör detta genom att skicka in ett uppgift-ID.

Uppgiftsexempelbild

Ställ in begärningshuvud och begärningskropp

Begärningshuvuden inkluderar:

accept: anger att du tar emot svar i JSON-format, här anges som application/json.
authorization: nyckeln för att anropa API:t, som kan väljas direkt efter ansökan.

Begärningskropp inkluderar:

id: det uppladdade uppgift-ID:t.
action: hur uppgiften ska hanteras.

Inställningarna visas i bilden nedan:

Kodexempel

Det kan noteras att olika språkets kod redan har genererats automatiskt på högra sidan, som visas i bilden:

Några kodexempel är som följer:

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

Svarsexempel

Vid en lyckad begäran kommer API:t att returnera detaljerad information om uppgiften här. Till exempel:

{
  "_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"
      }
    ]
  }
}

Det returnerade resultatet innehåller flera fält, där request-fältet är begärningskroppen vid uppgiftsstart, medan response-fältet är svaret som returneras efter att uppgiften har slutförts. Fälten beskrivs nedan.

id, ID:t för att generera denna uppgift, används för att unikt identifiera denna generering.
request, begärningsinformationen i uppgiften.
response, returinformationen i uppgiften; vid framgång är cost.amount den faktiska kostnaden i Credits för denna syntes.
created_at, tidpunkten för uppgiftens skapande, Unix-tidsstämpel (sekunder, flyttal).
started_at, tidpunkten för när uppgiften började utföras, Unix-tidsstämpel (sekunder, flyttal).
finished_at, tidpunkten för när uppgiften slutfördes, Unix-tidsstämpel (sekunder, flyttal). Detta fält returneras inte om uppgiften inte är slutförd.
elapsed, den tid som uppgiften tog att utföra, i sekunder (flyttal, med 3 decimaler). Detta fält returneras inte om uppgiften inte är slutförd.

Batchfrågeoperation

Detta är för att fråga om detaljerna för flera uppgift-ID:n, och till skillnad från ovanstående behöver action väljas som retrieve_batch. Begärningskropp inkluderar:

ids: en array av uppladdade uppgift-ID:n.
action: hur uppgiften ska hanteras.

Inställningarna visas i bilden nedan:

Kodexempel

Det kan noteras att olika språkets kod redan har genererats automatiskt på högra sidan, som visas i bilden:

Några kodexempel är som följer:

Svarsexempel

Vid en lyckad begäran kommer API:t att returnera detaljerad information om alla batchuppgifter. Till exempel:

{
  "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": "en vit siamesisk katt",
        "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": "en vit siamesisk katt",
        "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，批量 uppgifter av alla specifika detaljer. Det är en array, varje element i arrayen har samma format som resultatet av att fråga en enskild uppgift.
count，antalet av batchfrågeuppgifter.

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

Felhantering

Vid anrop av API:et, om ett fel uppstår, kommer API:et att returnera motsvarande felkod och information. Till exempel:

400 token_mismatched：Dålig begäran, möjligtvis på grund av saknade eller ogiltiga parametrar.
400 api_not_implemented：Dålig begäran, möjligtvis på grund av saknade eller ogiltiga parametrar.
401 invalid_token：Obehörig, ogiltig eller saknad auktoriseringstoken.
429 too_many_requests：För många begärningar, du har överskridit hastighetsgränsen.
500 api_error：Intern serverfel, något gick fel på servern.

Felrespons exempel

{
  "success": false,
  "error": {
    "code": "api_error",
    "message": "hämtning misslyckades"
  },
  "trace_id": "2cf86e86-22a4-46e1-ac2f-032c0f2a4e89"
}

Slutsats

Genom detta dokument har du fått en förståelse för hur man använder Fish Tasks API för att fråga enskilda eller batchuppgifter av alla specifika detaljer. Vi hoppas att detta dokument kan hjälpa dig att bättre integrera och använda API:et. Om du har några frågor, tveka inte att kontakta vårt tekniska supportteam.

Getting Started

AI Samtal

AI Bild

AI Video

AI Ljud

Web & Data

CAPTCHA

Identitet

Proxy

Advanced

Coding

Fish Tasks API:s integration och användning

Ansökningsprocess

Begärningsexempel

Uppgiftsexempelbild

Ställ in begärningshuvud och begärningskropp

Kodexempel

CURL

Svarsexempel

Batchfrågeoperation

Kodexempel

Svarsexempel

CURL

Felhantering

Felrespons exempel

Slutsats

​Ansökningsprocess

​Begärningsexempel

​Uppgiftsexempelbild

​Ställ in begärningshuvud och begärningskropp

​Kodexempel

​CURL

​Svarsexempel

​Batchfrågeoperation

​Kodexempel

​Svarsexempel

​CURL

​Felhantering

​Felrespons exempel

​Slutsats

Ansökningsprocess

Begärningsexempel

Uppgiftsexempelbild

Ställ in begärningshuvud och begärningskropp

Kodexempel

CURL

Svarsexempel

Batchfrågeoperation

Kodexempel

Svarsexempel

CURL

Felhantering

Felrespons exempel

Slutsats