Hoppa till huvudinnehåll

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.

Denna dokumentation introducerar Fish Model Query API (GET /fish/model) för integration. Detta gränssnitt är fullt kompatibelt med Fish Audio officiella OpenAPI och används för att sidindela listan över klonade ljudmodeller som är synliga för det aktuella kontot eller hela plattformen.
För att skapa ljudmodeller, se Fish Model Create API. För att hämta detaljer för en enskild modell via _id, se Fish Model Get API.

​
Ansökningsprocess

För att använda API:et måste du först ansöka om motsvarande tjänst på sidan Fish Model API. När du är på sidan klickar du på knappen “Acquire”. Om du inte är inloggad eller registrerad kommer du automatiskt att omdirigeras till inloggningssidan för att registrera dig och logga in. Efter inloggning återgår du automatiskt till den aktuella sidan. Vid första ansökan tilldelas du ett gratis kvotutrymme, vilket gör att du kan använda detta API utan kostnad.

​
Skillnader jämfört med officiella API:et

  • Autentiseringsmetod: Använd Authorization: Bearer {token}, där {token} är den nyckel du ansökt om på plattformen.
  • Svarstruktur: Direkt vidarebefordran av Fish upstreams paginerade svar, utan plattformsinramning; vid fel används den standardiserade plattformsstrukturen {success:false, error:{code,message}, trace_id}.

​
Exempel på förfrågan

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'

​
Begärda parametrar

I enlighet med Fish officiella:
  • page_size: Antal poster per sida, standard 10.
  • page_number: Sidnummer, börjar från 1.
  • title: Sök med delvis matchning på titel.
  • tag: Filtrera efter taggar.
  • self: Om true, returnerar endast ljudmodeller skapade av det aktuella kontot.
  • author_id: Filtrera efter skapare.
  • language: Filtrera efter ljudmodellens språk.
  • title_language: Filtrera efter titelns språk.

​
Exempel på svar

Ett framgångsrikt svar vidarebefordrar direkt Fish plattforms paginerade struktur: 
{
  "items": [
    {
      "_id": "d7900c21663f485ab63ebdb7e5905036",
      "title": "Min klonade ljudmodell",
      "description": "En ljudmodell klonad från en podcast-inspelning",
      "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
}
Det returnerade _id kan användas som reference_id i Fish TTS API för att använda den klonade ljudmodellen vid talgenerering.

​
Prissättning

Detta API är gratis — sidindelning av ljudmodell-listan är kostnadsfri. Endast när du använder POST /fish/model och inkluderar voices-fältet för att skapa en ny modell debiteras.

​
Felhantering

  • 400 token_mismatched: Saknade eller ogiltiga parametrar.
  • 400 api_not_implemented: Begäran metod eller parametrar stöds inte för tillfället.
  • 401 invalid_token: Saknad eller ogiltig autentiseringsinformation.
  • 429 too_many_requests: Överskridit den aktuella kontots hastighetsgräns.
  • 500 api_error: Internt serverfel.

​
Felresponsexempel

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

​
Slutsats

Fish Model Query API erbjuder en helt kompatibel ljudmodellssökfunktion med Fish Audio officiella API:et, vilket möjliggör att underhålla ett eget bibliotek av klonade ljudmodeller på plattformen. Tillsammans med Fish Model Get API kan du hämta fullständiga detaljer för en enskild modell via ID.