Fish Tasks API Integration and Usage

Die Hauptfunktion der Fish Tasks API besteht darin, den Status der Ausführung eines Auftrags anhand der von der Fish Audios Generation API generierten Auftrags-ID abzufragen. Dieses Dokument wird die Integrationsanleitung der Fish Tasks API detailliert beschreiben, um Ihnen zu helfen, diese API einfach zu integrieren und ihre leistungsstarken Funktionen voll auszuschöpfen. Mit der Fish Tasks API können Sie den Status der Ausführung von Aufträgen der Fish Audios Generation API problemlos abfragen.

Antragsprozess

Um die Fish Audios Generation API zu nutzen, müssen Sie zunächst im Ace Data Cloud Dashboard Ihr API-Token abrufen und für zukünftige Verwendung aufbewahren.

Wenn Sie noch nicht angemeldet oder registriert sind, werden Sie automatisch zur Anmeldeseite weitergeleitet, wo Sie zur Registrierung und Anmeldung eingeladen werden. Nach Abschluss werden Sie automatisch zur aktuellen Seite zurückgeleitet. Ein API-Token reicht aus, um auf alle Dienste der Plattform zuzugreifen, ohne dass für jeden Dienst separat ein Antrag gestellt werden muss. Bei der ersten Beantragung erhalten Sie ein kostenloses Kontingent, um die Dienste kostenlos auszuprobieren; wenn das Kontingent erschöpft ist, können Sie im Dashboard Ihr Guthaben aufladen.

📘 Vollständige Dokumentation: Fish Audios Generation API →

Anfragebeispiel

Die Fish Tasks API kann verwendet werden, um die Ergebnisse der Fish Audios Generation API abzufragen. Informationen zur Verwendung der Fish Audios Generation API finden Sie in der Dokumentation Fish Videos Generation API. Wir nehmen als Beispiel eine von der Fish Audios Generation API zurückgegebene Auftrags-ID und demonstrieren, wie man diese API verwendet. Angenommen, wir haben eine Auftrags-ID: 2725a2d3-f87e-4905-9c53-9988d5a7b2f5, im Folgenden zeigen wir, wie man durch Eingabe einer Auftrags-ID vorgeht.

Beispielbild des Auftrags

Anfrageheader und Anfragekörper festlegen

Request Headers umfassen:

accept: Gibt an, dass die Antwort im JSON-Format empfangen werden soll, hier eingetragen als application/json.
authorization: Der Schlüssel zur Aufrufung der API, nach der Beantragung kann dieser direkt ausgewählt werden.

Request Body umfasst:

id: Die hochgeladene Auftrags-ID.
action: Die Art der Operation auf dem Auftrag.

Einstellung wie im folgenden Bild gezeigt:

Codebeispiel

Es ist zu erkennen, dass auf der rechten Seite der Seite bereits automatisch Code in verschiedenen Sprachen generiert wurde, wie im Bild gezeigt:

Einige Codebeispiele sind wie folgt:

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

Antwortbeispiel

Nach erfolgreicher Anfrage gibt die API die Detailinformationen zu diesem Auftrag zurück. Zum Beispiel:

{
  "_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": "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://platform.r2.fish.audio/task/b627c2f7d38a4083a837570ba6d0962f.mp3"
      }
    ]
  }
}

Die Rückgabe enthält mehrere Felder, das Feld request ist der request body, der beim Starten des Auftrags gesendet wurde, während das Feld response der response body ist, der nach Abschluss des Auftrags zurückgegeben wird. Die Feldbeschreibung ist wie folgt.

id, die ID, die diesen Auftrag generiert hat, um diesen Generierungsauftrag eindeutig zu identifizieren.
request, die Anfrageinformationen im Auftrag.
response, die Rückgabeinformationen im Auftrag.
created_at, die Erstellungszeit des Auftrags, Unix-Zeitstempel (Sekunden, Fließkomma).
started_at, die Startzeit der Auftragsausführung, Unix-Zeitstempel (Sekunden, Fließkomma).
finished_at, die Abschlusszeit des Auftrags, Unix-Zeitstempel (Sekunden, Fließkomma). Dieses Feld wird nicht zurückgegeben, wenn der Auftrag nicht abgeschlossen ist.
elapsed, die Ausführungszeit des Auftrags, gemessen in Sekunden (Fließkomma, auf 3 Dezimalstellen gerundet). Dieses Feld wird nicht zurückgegeben, wenn der Auftrag nicht abgeschlossen ist.

Batch-Abfrageoperation

Dies ist eine Abfrage von Auftragsdetails für mehrere Auftrags-IDs, im Gegensatz zu oben muss die Aktion auf retrieve_batch gesetzt werden. Request Body umfasst:

ids: Ein Array der hochgeladenen Auftrags-IDs.
action: Die Art der Operation auf dem Auftrag.

Einstellung wie im folgenden Bild gezeigt:

Codebeispiel

Es ist zu erkennen, dass auf der rechten Seite der Seite bereits automatisch Code in verschiedenen Sprachen generiert wurde, wie im Bild gezeigt:

Einige Codebeispiele sind wie folgt:

Antwortbeispiel

Nach erfolgreicher Anfrage gibt die API die spezifischen Detailinformationen zu allen Batch-Aufträgen zurück. Zum Beispiel:

{
  "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": "eine weiße Siamkatze",
        "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": "eine weiße Siamkatze",
        "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
}

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

Fehlerbehandlung

Bei der Verwendung der API, wenn ein Fehler auftritt, gibt die API den entsprechenden Fehlercode und die Informationen zurück. Zum Beispiel:

400 token_mismatched: Ungültige Anfrage, möglicherweise aufgrund fehlender oder ungültiger Parameter.
400 api_not_implemented: Ungültige Anfrage, möglicherweise aufgrund fehlender oder ungültiger Parameter.
401 invalid_token: Unbefugt, ungültiger oder fehlender Autorisierungstoken.
429 too_many_requests: Zu viele Anfragen, Sie haben das Limit überschritten.
500 api_error: Interner Serverfehler, etwas ist auf dem Server schiefgelaufen.

Fehlerantwort Beispiel

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

Fazit

Durch dieses Dokument haben Sie gelernt, wie Sie die Fish Tasks API verwenden, um die spezifischen Detailinformationen zu einzelnen oder Batch-Aufgaben abzufragen. Wir hoffen, dass dieses Dokument Ihnen hilft, die API besser zu integrieren und zu nutzen. Bei Fragen wenden Sie sich bitte jederzeit an unser technisches Support-Team.

Erste Schritte

KI Chat

KI Bild

KI Video

KI Audio

Web & Daten

CAPTCHA

Identität

Proxy

Erweitert

Fish Tasks API Integration and Usage

Antragsprozess

Anfragebeispiel

Beispielbild des Auftrags

Anfrageheader und Anfragekörper festlegen

Codebeispiel

CURL

Antwortbeispiel

Batch-Abfrageoperation

Codebeispiel

Antwortbeispiel

CURL

Fehlerbehandlung

Fehlerantwort Beispiel

Fazit

​Antragsprozess

​Anfragebeispiel

​Beispielbild des Auftrags

​Anfrageheader und Anfragekörper festlegen

​Codebeispiel

​CURL

​Antwortbeispiel

​Batch-Abfrageoperation

​Codebeispiel

​Antwortbeispiel

​CURL

​Fehlerbehandlung

​Fehlerantwort Beispiel

​Fazit

Antragsprozess

Anfragebeispiel

Beispielbild des Auftrags

Anfrageheader und Anfragekörper festlegen

Codebeispiel

CURL

Antwortbeispiel

Batch-Abfrageoperation

Codebeispiel

Antwortbeispiel

CURL

Fehlerbehandlung

Fehlerantwort Beispiel

Fazit