Passer au contenu principal

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.

Ce document présente les instructions d’intégration de l’API Fish Model Get (GET /fish/model/{id}), une interface entièrement compatible avec l’OpenAPI officielle de Fish Audio, utilisée pour interroger les détails complets d’un clone de timbre unique par son ID.
Pour la création de timbres, veuillez consulter l’API Fish Model Create, et pour les requêtes de liste paginée, référez-vous à l’API Fish Model Query.

​
Processus de demande

Pour utiliser l’API, vous devez d’abord faire une demande de service correspondante sur la page Fish Model API. Une fois sur la page, cliquez sur le bouton « Acquire ». Si vous n’êtes pas encore connecté ou inscrit, vous serez automatiquement redirigé vers la page de connexion pour vous inviter à vous inscrire et vous connecter. Après connexion ou inscription, vous serez automatiquement ramené à la page actuelle. Une allocation gratuite est offerte lors de la première demande, ce qui permet d’utiliser cette API gratuitement.

​
Différences avec l’API officielle

  • Méthode d’authentification : Utilisation de Authorization: Bearer {token}, où {token} est la clé obtenue via cette plateforme.
  • Structure de la réponse : L’objet ModelEntity de Fish est transmis directement sans enveloppe spécifique de la plateforme ; en cas d’erreur, la structure standard de la plateforme {success:false, error:{code,message}, trace_id} est utilisée.
  • Paramètre de chemin : {id} correspond à l’_id du timbre, retourné lors de la création via l’API Fish Model Create ou obtenu via la requête paginée de l’API Fish Model Query.

​
Exemple de requête

curl 'https://api.xhuoapi.ai/v1/fish/model/d7900c21663f485ab63ebdb7e5905036' \
  -H 'accept: application/json' \
  -H 'authorization: Bearer {token}'
Il suffit de remplacer {id} dans l’URL par l’ID spécifique du timbre, sans paramètre de requête ni corps de requête supplémentaires.

​
Exemple de réponse

La réponse réussie transmet directement l’objet ModelEntity de la plateforme Fish : 
{
  "_id": "d7900c21663f485ab63ebdb7e5905036",
  "type": "tts",
  "title": "我的克隆音色",
  "description": "用一段播客录音克隆的音色",
  "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": ""
  }
}
L’_id retourné peut être utilisé comme valeur du champ reference_id dans la suite de l’API Fish TTS pour synthétiser la voix clonée.

​
Informations tarifaires

Cette interface est gratuite — la consultation des détails d’un timbre par ID est une opération gratuite. Seule la création d’un nouveau timbre via POST /fish/model avec le champ voices dans le corps de la requête est facturée.

​
Gestion des erreurs

  • 400 token_mismatched : paramètres de requête manquants ou invalides.
  • 400 api_not_implemented : méthode ou paramètres non supportés actuellement.
  • 401 invalid_token : informations d’authentification manquantes ou invalides.
  • 404 not_found : timbre correspondant à l’_id spécifié introuvable ou non visible pour le compte actuel.
  • 429 too_many_requests : dépassement de la limite de débit du compte.
  • 500 api_error : erreur interne du serveur.

​
Exemple de réponse d’erreur

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

​
Conclusion

L’API Fish Model Get offre une capacité de consultation des détails d’un timbre unique totalement compatible avec Fish Audio officiel. Une fois l’ID du timbre obtenu, cette interface permet de récupérer l’objet ModelEntity complet (y compris les échantillons, l’état, la visibilité, les champs statistiques, etc.), qui peut ensuite être utilisé avec l’API Fish TTS pour réaliser un flux complet de clonage et de synthèse vocale.