Hoppa till huvudinnehåll
Fish Tasks API:s huvudsakliga funktion är att fråga om exekveringsstatusen för en uppgift genom att ange uppgifts-ID:t som genererats av Fish Audios Generation API. Det här dokumentet beskriver integreringsanvisningarna för Fish Tasks API i detalj, för att hjälpa dig att enkelt integrera och utnyttja API:ets kraftfulla funktioner fullt ut. Genom Fish Tasks API kan du enkelt fråga om exekveringsstatusen för uppgifter i Fish Audios Generation API.

Ansökningsprocess

För att använda Fish Audios Generation API, hämta först din API Token från Ace Data Cloud-konsolen och spara den för senare användning. Om du ännu inte är inloggad eller registrerad omdirigeras du automatiskt till inloggningssidan, där du uppmanas att registrera dig och logga in. När detta är klart återvänder du automatiskt till den aktuella sidan. En API Token kan användas för att anropa alla plattformstjänster, utan att behöva ansöka separat för varje tjänst. Vid den första ansökan får du gratis kredit för kostnadsfri testning; när krediten inte räcker till kan du fylla på ditt allmänna saldo i konsolen.
📘 Fullständig dokumentation: Fish Audios Generation API →

Begäransexempel

Fish Tasks API kan användas för att fråga efter resultat från Fish Audios Generation API. För information om hur du använder Fish Audios Generation API, se dokumentationen Fish Videos Generation API . Vi använder ett uppgifts-ID som returneras av Fish Audios Generation API-tjänsten som exempel för att visa hur detta API används. Anta att vi har ett uppgifts-ID: 2725a2d3-f87e-4905-9c53-9988d5a7b2f5, nedan visas hur man genom att skicka in ett uppgifts-ID kan.

Bildexempel för uppgift

Ställ in begärandehuvuden och begärandetext

Request Headers omfattar:
  • accept: Anger att svar i JSON-format ska tas emot, här anges application/json.
  • authorization: Nyckeln för att anropa API:t, som efter ansökan kan väljas direkt från rullgardinsmenyn.
Request Body omfattar:
  • id: Det uppladdade uppgifts-ID:t.
  • action: Åtgärden för uppgiften.
Inställningarna visas i bilden nedan:

Kodexempel

Du kan se att kod för olika språk redan har genererats automatiskt på höger sida av sidan, som visas i bilden:

Några kodexempel följer:

CURL

Svarsexempel

Efter en lyckad begäran returnerar API:t detaljerad information om uppgiften här. Till exempel:
Det returnerade resultatet innehåller flera fält. Fältet request är request body när uppgiften startas, medan fältet response är response body som returneras när uppgiften är slutförd. Fälten beskrivs nedan.
  • id, ID:t för att generera denna uppgift, som används för att unikt identifiera denna genereringsuppgift.
  • request, begärandeinformationen i frågeuppgiften.
  • response, returneringsinformationen i frågeuppgiften; vid slutlig framgång är cost.amount i detta den Credits som faktiskt dras för denna syntes.
  • created_at, tidpunkt då uppgiften skapades, Unix-tidsstämpel (sekunder, flyttal).
  • started_at, tidpunkt då uppgiften började köras, Unix-tidsstämpel (sekunder, flyttal).
  • finished_at, tidpunkt då uppgiften slutfördes, Unix-tidsstämpel (sekunder, flyttal). Detta fält returneras inte när uppgiften inte är slutförd.
  • elapsed, tidsåtgång för uppgiftskörningen, i sekunder (flyttal, med 3 decimaler). Detta fält returneras inte när uppgiften inte är slutförd.

Åtgärd för batchfrågor

Detta används för att fråga efter uppgiftsdetaljer för flera uppgifts-ID:n. Skillnaden från ovan är att action måste väljas som retrieve_batch Request Body omfattar:
  • ids: Matrisen med uppladdade uppgifts-ID:n.
  • action: Åtgärden för uppgiften.
Inställningarna visas i bilden nedan:

Kodexempel

Du kan se att kod för olika språk redan har genererats automatiskt på höger sida av sidan, som visas i bilden:

Några kodexempel följer:

Svarsexempel

Efter en lyckad begäran returnerar API:t detaljerad information om alla batchuppgifter denna gång. Till exempel:
Resultatet innehåller flera fält, där items innehåller den specifika detaljinformationen för batchuppgifter. Den specifika informationen för varje uppgift är densamma som fälten ovan, och fältinformationen är följande.
  • items, all specifik detaljinformation för batchuppgifter. Det är en array där varje element har samma format som returresultatet vid frågan om en enskild uppgift ovan.
  • count, antalet uppgifter i batchfrågan här.

CURL

Felhantering

När API:et anropas, om ett fel uppstår, returnerar API:et motsvarande felkod och information. Till exempel:
  • 400 token_mismatched: Felaktig begäran, möjligen på grund av saknade eller ogiltiga parametrar.
  • 400 api_not_implemented: Felaktig begäran, möjligen 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äranden, du har överskridit hastighetsgränsen.
  • 500 api_error: Internt serverfel, något gick fel på servern.

Exempel på felsvar

Slutsats

Genom detta dokument har du redan förstått hur du använder Fish Tasks API för att fråga efter all specifik detaljinformation för en enskild uppgift eller batchuppgifter. Vi hoppas att detta dokument kan hjälpa dig att bättre integrera och använda detta API. Om du har några frågor, vänligen kontakta vårt tekniska supportteam när som helst.