API Referenz
Fish Audio Open API-Endpunktreferenz.
API Referenz
Das Fish Audio Open API ist die serverseitige Schnittstelle für Produktions-Audio-Workflows. Verwenden Sie es, wenn Ihr Produkt Text-zu-Sprache, Sprache-zu-Text, Sprachverwaltung oder Lippensynchronisierungsautomatisierung benötigt, ohne auf die Webkonsole angewiesen zu sein.
Basis-URL:
https://fishaudio.org/api/open/v1Authentifizierung:
Authorization: Bearer FISHAUDIO_API_KEYMaschinenlesbares Schema:
GET /api/openapi.jsonAktuelle öffentliche Oberflächen
| Oberfläche | Aktueller Status im Ausland API | Dokumente |
|---|---|---|
| Profil | Öffentlicher v1-Endpunkt für Konto-, Stufen-, Guthaben- und Kontingentprüfungen | Profil |
| Text-to-Speech | Öffentliche Synchronisierung HTTP und asynchrone Jobendpunkte | HTTP synchronisieren, Asynchrone Jobs |
| Echtzeit TTS | Die Verfügbarkeit wird durch Konto und Produkteinführung gesteuert | Echtzeit TTS |
| Sprache zum Text | Öffentlicher Transkriptionsendpunkt HTTP | Sprache zu Text |
| Echtzeit ASR | Die Verfügbarkeit wird durch Konto und Produkteinführung gesteuert | Echtzeit ASR |
| Bilder | Produktfähigkeitsseite; Die Verfügbarkeit öffentlicher Endpunkte ist schemagesteuert | Bilder |
| Videos | Produktfähigkeitsseite; Die Verfügbarkeit öffentlicher Endpunkte ist schemagesteuert | Videos |
| Sprachverwaltung | Öffnen Sie API-Endpunkte zum Auflisten, Erstellen und Löschen von Sprachmodellen | Sprachverwaltung |
| Lippensynchronisation | Öffentliche asynchrone Auftragsendpunkte für Quellvideo- und Audio-Workflows | Lippensynchronisation |
| Verwendung | Anleitung zur Kontonutzung; Profil heute verwenden und Schema für neue Nutzungsendpunkte | Verwendung |
Modell anfordern
Alle Anfragen sollten von Ihrem Server erfolgen. Browser-Clients und mobile Apps sollten zuerst Ihr eigenes Backend aufrufen, dann ruft Ihr Backend das Open API mit dem Schlüssel API auf.
curl https://fishaudio.org/api/open/v1/profile \
-H "Authorization: Bearer FISHAUDIO_API_KEY"Verwenden Sie JSON für die meisten Endpunkte. Bei der Spracherstellung können mehrteilige Formulardaten verwendet werden, wenn der aktivierte Anbieter Referenzaudio benötigt. Binäre Audioantworten werden von der Synchronisierung TTS verwendet, wenn Sie direktes Audio anstelle zwischengespeicherter Metadaten anfordern.
Antwortmodell
Erfolgreiche Antworten sind endpunktspezifisch. Asynchrone Endpunkte geben Job- oder Aufgabenobjekte zurück, die Ihre Anwendung abfragen sollte, bis ein Terminalstatus erreicht ist. Synchronisierungsmedienendpunkte können je nach Anforderungsoptionen Binärdaten oder JSON-Metadaten zurückgeben.
Fehler verwenden einen JSON-Körper:
{
"code": "invalid_request",
"message": "The request payload is invalid.",
"requestId": "req_xxx"
}Protokollieren Sie requestId, wenn es vorhanden ist. Dies ist für den Support die schnellste Möglichkeit, eine fehlgeschlagene Anfrage nachzuverfolgen.
Abrechnung und Gutschriften
Offene API-Aufrufe verbrauchen je nach Endpunkt und aktiviertem Modell Kontoguthaben oder API-Kontingent. Einige Endpunkte erheben Gebühren, wenn eine Aufgabe angenommen wird. andere erheben Gebühren, wenn die Mediengenerierung erfolgreich ist. Ihre Integration sollte einen eindeutigen Wiederholungsstatus anzeigen und nicht davon ausgehen, dass jede fehlgeschlagene Anfrage Credits kostet.
Rufen Sie für Balance-empfindliche Arbeitsabläufe Profile auf, bevor Sie große Stapel starten und nachdem wichtige Aufträge abgeschlossen sind. Langzeitjobs sollten auch die zurückgegebene Aufgaben-ID beibehalten, damit Sie nach Client-Neustarts eine Wiederherstellung durchführen können, ohne doppelte Arbeit zu erstellen.
Kompatibilität
Ältere offene API-Pfade bleiben während des Kompatibilitätsfensters verfügbar, neue Integrationen sollten jedoch /api/open/v1 verwenden. Der Migrationsleitfaden listet bekannte Pfadersetzungen und Rollout-Reihenfolge auf.
Die ausländischen Dokumente nutzen bewusst ihre eigenen aktuellen Pfade. Wenn Sie die globale Site integrieren, folgen Sie den Pfaden unter https://fishaudio.org/api/open/v1 und bestätigen Sie neue Oberflächen mit GET /api/openapi.json.