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 Artikel beschreibt die Integrationsanleitung für die Fish Model Get API (GET /fish/model/{id}). Diese Schnittstelle ist vollständig kompatibel mit der Fish Audio offiziellen OpenAPI und dient dazu, einzelne Klon-Stimmen anhand der Stimmen-ID mit vollständigen Details abzufragen.
Zur Erstellung von Stimmen siehe bitte Fish Model Create API. Für paginierte Listenabfragen siehe Fish Model Query API.

Antragsprozess

Um die API zu nutzen, müssen Sie zunächst auf der entsprechenden Seite der Fish Model API den Dienst beantragen. Nach dem Aufruf der Seite klicken Sie auf die Schaltfläche „Acquire“. Falls Sie noch nicht eingeloggt oder registriert sind, werden Sie automatisch zur Login-Seite weitergeleitet, wo Sie sich registrieren und anmelden können. Nach dem Login oder der Registrierung kehren Sie automatisch zur aktuellen Seite zurück. Bei der ersten Beantragung erhalten Sie ein kostenloses Kontingent, mit dem Sie die API kostenfrei nutzen können.

Unterschiede zur offiziellen API

  • Authentifizierungsmethode: Verwendung von Authorization: Bearer {token}, wobei {token} der auf dieser Plattform beantragte Schlüssel ist.
  • Antwortstruktur: Das ModelEntity-Objekt von Fish wird direkt durchgereicht, ohne eine zusätzliche Plattform-Envelope-Verpackung; bei Fehlern wird die plattformübliche Struktur {success:false, error:{code,message}, trace_id} verwendet.
  • Pfadparameter: {id} ist die _id der Stimme, die entweder bei der Erstellung über die Fish Model Create API zurückgegeben oder bei der paginierten Abfrage über die Fish Model Query API erhalten wird.

Beispielanfrage

curl 'https://api.xhuoapi.ai/v1/fish/model/d7900c21663f485ab63ebdb7e5905036' \
  -H 'accept: application/json' \
  -H 'authorization: Bearer {token}'
Ersetzen Sie einfach {id} im URL-Pfad durch die konkrete Stimmen-ID. Es sind keine weiteren Abfrageparameter oder Request-Body erforderlich.

Beispielantwort

Eine erfolgreiche Antwort gibt das ModelEntity-Objekt der Fish-Plattform direkt zurück:
{
  "_id": "d7900c21663f485ab63ebdb7e5905036",
  "type": "tts",
  "title": "Meine Klon-Stimme",
  "description": "Eine Stimme, die mit einer Podcast-Aufnahme geklont wurde",
  "cover_image": "https://example.com/cover.png",
  "train_mode": "fast",
  "state": "trained",
  "tags": [],
  "samples": [
    {
      "audio": "https://example.com/sample-voice.mp3",
      "text": ""
    }
  ],
  "created_at": "2025-05-09T12:34:56.789Z",
  "updated_at": "2025-05-09T12:34:56.789Z",
  "languages": ["zh", "en"],
  "visibility": "private",
  "lock_visibility": false,
  "default_text": "",
  "default_mode": "fast",
  "like_count": 0,
  "mark_count": 0,
  "shared_count": 0,
  "task_count": 0,
  "unliked": false,
  "liked": false,
  "marked": false,
  "author": {
    "_id": "00000000000000000000000000000000",
    "nickname": "",
    "avatar": ""
  }
}
Die zurückgegebene _id kann als Wert für das Feld reference_id in der nachfolgenden Fish TTS API verwendet werden, um mit dieser Klon-Stimme Sprachsynthese durchzuführen.

Abrechnungshinweise

Diese Schnittstelle ist kostenfrei — das Abfragen von Stimmen-Details per ID ist kostenlos. Nur POST /fish/model mit dem Feld voices im Request-Body zur Erstellung neuer Stimmen wird berechnet.

Fehlerbehandlung

  • 400 token_mismatched: Fehlende oder ungültige Anfrageparameter.
  • 400 api_not_implemented: Aktuell nicht unterstützte Anfragemethode oder Parameter.
  • 401 invalid_token: Fehlende oder ungültige Authentifizierungsinformationen.
  • 404 not_found: Die angegebene _id existiert nicht oder ist für das aktuelle Konto nicht sichtbar.
  • 429 too_many_requests: Überschreitung des Ratenlimits für das aktuelle Konto.
  • 500 api_error: Interner Serverfehler.

Beispiel für eine Fehlerantwort

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

Fazit

Die Fish Model Get API bietet eine vollständig kompatible Möglichkeit, einzelne Stimmen-Details abzufragen. Nach Erhalt der Stimmen-ID kann mit dieser Schnittstelle das vollständige ModelEntity-Objekt (einschließlich Samples, Status, Sichtbarkeit, Statistikfelder etc.) abgerufen werden. In Kombination mit der Fish TTS API ermöglicht dies einen durchgängigen Klon- und Syntheseprozess.