Zum Hauptinhalt springen

Documentation Index

Fetch the complete documentation index at: https://docs.xhuoapi.ai/llms.txt

Use this file to discover all available pages before exploring further.

Dieser Abschnitt beschreibt die Integrationsanleitung für die Fish Model Query API (GET /fish/model). Diese Schnittstelle ist vollständig kompatibel mit der Fish Audio Offiziellen OpenAPI und dient zum Paginierten Abfragen der aktuellen oder plattformweit sichtbaren Klon-Soundsets.
Für die Erstellung von Soundsets siehe Fish Model Create API. Für die Abfrage einzelner Soundset-Details nach _id siehe Fish Model Get API.

​
Antragsprozess

Um die API zu nutzen, müssen Sie zunächst die entsprechende Dienstleistung auf der Fish Model API Seite beantragen. Nach dem Aufrufen der Seite klicken Sie auf die Schaltfläche „Acquire“. Wenn Sie noch nicht eingeloggt oder registriert sind, werden Sie automatisch zur Login-Seite weitergeleitet, wo Sie sich registrieren und anmelden können. Nach Anmeldung oder Registrierung kehren Sie automatisch zur aktuellen Seite zurück. Beim ersten Antrag erhalten Sie ein kostenloses Kontingent, mit dem Sie die API kostenlos nutzen können.

​
Unterschiede zur offiziellen API

  • Authentifizierungsmethode: Verwendung von Authorization: Bearer {token}, wobei {token} der auf dieser Plattform beantragte Schlüssel ist.
  • Antwortstruktur: Die paginierten Antworten von Fish werden direkt durchgeleitet, ohne Plattform-Envelope-Verpackung; bei Fehlern wird die standardisierte Plattformstruktur {success:false, error:{code,message}, trace_id} verwendet.

​
Anfragebeispiel

curl -G 'https://api.xhuoapi.ai/v1/fish/model' \
  -H 'accept: application/json' \
  -H 'authorization: Bearer {token}' \
  --data-urlencode 'page_size=10' \
  --data-urlencode 'page_number=1' \
  --data-urlencode 'self=true'

​
Abfrageparameter

Gleich wie bei Fish:
  • page_size: Anzahl der Einträge pro Seite, Standard 10.
  • page_number: Seitennummer, beginnt bei 1.
  • title: Suche nach Titel, unscharf.
  • tag: Filter nach Tags.
  • self: Bei Übermittlung von true nur Soundsets, die vom aktuellen Konto erstellt wurden.
  • author_id: Filter nach Ersteller.
  • language: Filter nach Soundset-Sprache.
  • title_language: Filter nach Titel-Sprache.

​
Antwortbeispiel

Erfolgreiche Antworten leiten die Fish-Plattform-Paginierung direkt durch: 
{
  "items": [
    {
      "_id": "d7900c21663f485ab63ebdb7e5905036",
      "title": "Mein Klon-Soundset",
      "description": "Ein Soundset, das mit einer Podcast-Aufnahme geklont wurde",
      "cover_image": "https://example.com/cover.png",
      "type": "tts",
      "state": "trained",
      "tags": [],
      "languages": ["zh", "en"],
      "visibility": "private",
      "created_at": "2025-05-09T12:34:56.789Z",
      "updated_at": "2025-05-09T12:34:56.789Z"
    }
  ],
  "total": 1
}
Das zurückgegebene _id kann als reference_id im Fish TTS API verwendet werden, um dieses Klon-Soundset für die Sprachsynthese zu referenzieren.

​
Abrechnungsinformationen

Diese Schnittstelle ist kostenfrei – die paginierte Abfrage der Soundsets ist kostenlos. Die Erstellung eines neuen Soundsets mittels POST /fish/model mit dem Feld voices im Request-Body ist kostenpflichtig.

​
Fehlerbehandlung

  • 400 token_mismatched: Fehlende oder ungültige Anfrageparameter.
  • 400 api_not_implemented: Nicht unterstützte Anfragemethode oder Parameter.
  • 401 invalid_token: Fehlende oder ungültige Authentifizierungsinformationen.
  • 429 too_many_requests: Überschreitung des aktuellen Kontingents.
  • 500 api_error: Interner Serverfehler.

​
Fehlerantwortbeispiel

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

​
Fazit

Die Fish Model Query API bietet eine vollständig kompatible Soundset-Abfragefunktion, mit der Sie eine eigene Klon-Soundset-Bibliothek auf dieser Plattform verwalten können. In Kombination mit Fish Model Get API können Sie einzelne Soundsets anhand ihrer ID vollständig abrufen.