Integracja i użycie Fish Tasks API

Główną funkcją Fish Tasks API jest sprawdzanie statusu wykonania zadania poprzez wprowadzenie ID zadania wygenerowanego przez Fish Audios Generation API. Ten dokument szczegółowo przedstawi instrukcje integracji Fish Tasks API, pomagając Ci łatwo zintegrować i w pełni wykorzystać potężne funkcje tego API. Za pomocą Fish Tasks API możesz łatwo realizować sprawdzanie statusu wykonania zadań Fish Audios Generation API.

Proces aplikowania

Aby używać Fish Audios Generation API, najpierw przejdź do konsoli Ace Data Cloud, aby uzyskać swój API Token i zachować go na później.

Jeśli jeszcze się nie zalogowałeś ani nie zarejestrowałeś, zostaniesz automatycznie przekierowany na stronę logowania, która zaprosi Cię do rejestracji i logowania, a po zakończeniu automatycznie powrócisz na bieżącą stronę. Jeden API Token może wywoływać wszystkie usługi platformy, nie ma potrzeby składania osobnego wniosku dla każdej usługi. Przy pierwszym wniosku otrzymasz darmowy limit, aby móc korzystać bezpłatnie; gdy limit będzie niewystarczający, możesz doładować uniwersalne saldo w konsoli.

📘 Pełna dokumentacja: Fish Audios Generation API →

Przykład żądania

Fish Tasks API może być używane do sprawdzania wyników Fish Audios Generation API. Informacje o tym, jak używać Fish Audios Generation API, znajdziesz w dokumentacji Fish Videos Generation API . Jako przykład weźmiemy jedno ID zadania zwrócone przez usługę Fish Audios Generation API, aby zademonstrować, jak używać tego API. Załóżmy, że mamy ID zadania: 2725a2d3-f87e-4905-9c53-9988d5a7b2f5, następnie zademonstrujemy, jak przez przekazanie jednego ID zadania.

Przykładowy obraz zadania

Ustawianie nagłówków żądania i treści żądania

Request Headers obejmują:

accept: określa odbieranie wyników odpowiedzi w formacie JSON, tutaj należy wpisać application/json.
authorization: klucz do wywołania API, po aplikowaniu można go bezpośrednio wybrać z listy rozwijanej.

Request Body obejmuje:

id: ID przesłanego zadania.
action: sposób operacji na zadaniu.

Ustawienia są pokazane na poniższym obrazku:

Przykład kodu

Można zauważyć, że po prawej stronie strony automatycznie wygenerowano już kod w różnych językach, jak pokazano na obrazku:

Niektóre przykłady kodu są następujące:

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

Przykład odpowiedzi

Po pomyślnym wysłaniu żądania API zwróci szczegółowe informacje o zadaniu tutaj. Na przykład:

{
  "_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://cdn.acedata.cloud/assets/examples/fish/5ade0339-5f11-487e-aacc-06a908271706-8e3fcb0e5547.mp3"
      }
    ]
  }
}

Zwrócony wynik zawiera łącznie wiele pól, pole request to request body podczas inicjowania zadania, natomiast pole response to response body zwrócone po ukończeniu zadania. Opis pól jest następujący.

id, ID generowania tego zadania, używane do jednoznacznej identyfikacji tego zadania generowania.
request, informacje o żądaniu w zadaniu sprawdzania.
response, informacje zwrotne w zadaniu sprawdzania; po ostatecznym sukcesie znajdujące się w nim cost.amount to Credits faktycznie odjęte za tę syntezę.
created_at, czas utworzenia zadania, znacznik czasu Unix (sekundy, liczba zmiennoprzecinkowa).
started_at, czas rozpoczęcia wykonywania zadania, znacznik czasu Unix (sekundy, liczba zmiennoprzecinkowa).
finished_at, czas ukończenia zadania, znacznik czasu Unix (sekundy, liczba zmiennoprzecinkowa). To pole nie jest zwracane, gdy zadanie nie jest ukończone.
elapsed, czas trwania wykonania zadania, w sekundach (liczba zmiennoprzecinkowa, zachowane 3 miejsca po przecinku). To pole nie jest zwracane, gdy zadanie nie jest ukończone.

Operacja zapytania wsadowego

Jest to sprawdzanie szczegółów zadania dla wielu ID zadań, różnica w stosunku do powyższego polega na konieczności wybrania action jako retrieve_batch Request Body obejmuje:

ids: tablica ID przesłanych zadań.
action: sposób operacji na zadaniu.

Ustawienia są pokazane na poniższym obrazku:

Przykład kodu

Można zauważyć, że po prawej stronie strony automatycznie wygenerowano już kod w różnych językach, jak pokazano na obrazku:

Niektóre przykłady kodu są następujące:

Przykład odpowiedzi

Po pomyślnym wysłaniu żądania API zwróci szczegółowe informacje o wszystkich zadaniach wsadowych tym razem. Na przykład:

{
  "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": "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://cdn.acedata.cloud/assets/examples/fish/5ade0339-5f11-487e-aacc-06a908271706-8e3fcb0e5547.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": "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://cdn.acedata.cloud/assets/examples/fish/5ade0339-5f11-487e-aacc-06a908271706-8e3fcb0e5547.mp3"
          }
        ]
      }
    }
  ],
  "count": 2
}

Zwracany wynik zawiera łącznie wiele pól, z których items zawiera szczegółowe informacje o zadaniach wsadowych, a szczegółowe informacje o każdym zadaniu są takie same jak pola opisane powyżej. Informacje o polach są następujące.

items, wszystkie szczegółowe informacje o zadaniach wsadowych. Jest to tablica, a format każdego elementu tablicy jest taki sam jak format wyniku zwracanego przy zapytaniu o pojedyncze zadanie opisanym powyżej.
count, liczba zadań w tym zapytaniu wsadowym.

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

Obsługa błędów

Podczas wywoływania API, jeśli wystąpi błąd, API zwróci odpowiedni kod błędu i informację. Na przykład:

400 token_mismatched: Nieprawidłowe żądanie, prawdopodobnie z powodu brakujących lub nieprawidłowych parametrów.
400 api_not_implemented: Nieprawidłowe żądanie, prawdopodobnie z powodu brakujących lub nieprawidłowych parametrów.
401 invalid_token: Brak autoryzacji, nieprawidłowy lub brakujący token autoryzacyjny.
429 too_many_requests: Zbyt wiele żądań, przekroczono limit szybkości.
500 api_error: Wewnętrzny błąd serwera, coś poszło nie tak na serwerze.

Przykład odpowiedzi błędu

{
  "success": false,
  "error": {
    "code": "api_error",
    "message": "fetch failed"
  },
  "trace_id": "2cf86e86-22a4-46e1-ac2f-032c0f2a4e89"
}

Wnioski

Dzięki temu dokumentowi dowiedzieli się Państwo, jak używać Fish Tasks API do zapytywania o wszystkie szczegółowe informacje dotyczące pojedynczego lub wsadowego zadania. Mamy nadzieję, że ten dokument pomoże Państwu lepiej zintegrować i używać tego API. W razie jakichkolwiek pytań prosimy o kontakt z naszym zespołem wsparcia technicznego.

Getting Started

Czat AI

Obraz AI

Wideo AI

Audio AI

Sieć i dane

CAPTCHA

Tożsamość

Coding

Więcej przewodników

Integracja i użycie Fish Tasks API

Proces aplikowania

Przykład żądania

Przykładowy obraz zadania

Ustawianie nagłówków żądania i treści żądania

Przykład kodu

CURL

Przykład odpowiedzi

Operacja zapytania wsadowego

Przykład kodu

Przykład odpowiedzi

CURL

Obsługa błędów

Przykład odpowiedzi błędu

Wnioski

​Proces aplikowania

​Przykład żądania

​Przykładowy obraz zadania

​Ustawianie nagłówków żądania i treści żądania

​Przykład kodu

​CURL

​Przykład odpowiedzi

​Operacja zapytania wsadowego

​Przykład kodu

​Przykład odpowiedzi

​CURL

​Obsługa błędów

​Przykład odpowiedzi błędu

​Wnioski

Proces aplikowania

Przykład żądania

Przykładowy obraz zadania

Ustawianie nagłówków żądania i treści żądania

Przykład kodu

CURL

Przykład odpowiedzi

Operacja zapytania wsadowego

Przykład kodu

Przykład odpowiedzi

CURL

Obsługa błędów

Przykład odpowiedzi błędu

Wnioski