API Référence

Fish Audio Open API est l'interface côté serveur pour les flux de travail de production audio. Utilisez-le lorsque votre produit a besoin d'une synthèse vocale, d'une synthèse vocale, d'une gestion vocale ou d'une automatisation de la synchronisation labiale sans recourir à la console Web.

URL de base :

https://fishaudio.org/api/open/v1

Authentification:

Authorization: Bearer FISHAUDIO_API_KEY

Schéma lisible par machine :

GET /api/openapi.json

Surfaces publiques actuelles

Surfaces	Statut actuel de API à l’étranger	Documents
Profil	Point de terminaison public v1 pour les vérifications de compte, de niveau, de crédits et de quotas	Profil
Synthèse vocale	Synchronisation publique HTTP et points de terminaison de tâches asynchrones	Synchroniser HTTP, Tâches asynchrones
Temps réel TTS	La disponibilité est contrôlée par le compte et le déploiement du produit	TTS en temps réel
Discours en texte	Point final de transcription public HTTP	Parole en texte
Temps réel ASR	La disponibilité est contrôlée par le compte et le déploiement du produit	ASR en temps réel
Images	Page de capacité du produit ; la disponibilité des points de terminaison publics est basée sur un schéma	Images
Vidéos	Page de capacité du produit ; la disponibilité des points de terminaison publics est basée sur un schéma	Vidéos
Gestion de la voix	Ouvrez les points de terminaison API pour répertorier, créer et supprimer des modèles vocaux	Gestion vocale
Synchronisation labiale	Points de terminaison publics des tâches asynchrones pour les flux de travail vidéo et audio source	Synchronisation labiale
Utilisation	Conseils d'utilisation du compte ; utiliser le profil aujourd'hui et le schéma pour les nouveaux points de terminaison d'utilisation	Utilisation

Modèle de demande

Toutes les demandes doivent être effectuées depuis votre serveur. Les clients de navigateur et les applications mobiles doivent d'abord appeler votre propre backend, puis votre backend appelle Open API avec la clé API.

curl https://fishaudio.org/api/open/v1/profile \
  -H "Authorization: Bearer FISHAUDIO_API_KEY"

Utilisez JSON pour la plupart des points de terminaison. La création vocale peut utiliser des données de formulaire en plusieurs parties lorsque le fournisseur activé requiert un audio de référence. Les réponses audio binaires sont utilisées par sync TTS lorsque vous demandez de l'audio direct au lieu de métadonnées mises en cache.

Modèle de réponse

Les réponses réussies sont spécifiques au point final. Les points de terminaison asynchrones renvoient des objets de travail ou de tâche que votre application doit interroger jusqu'à ce qu'un état de terminal soit atteint. Les points de terminaison multimédia de synchronisation peuvent renvoyer des données binaires ou des métadonnées JSON en fonction des options de demande.

Les erreurs utilisent un corps JSON :

{
  "code": "invalid_request",
  "message": "The request payload is invalid.",
  "requestId": "req_xxx"
}

Enregistrez requestId lorsqu'il est présent. Il s’agit du moyen le plus rapide pour l’assistance de retracer une demande ayant échoué.

Facturation et crédits

Les appels ouverts API consomment des crédits de compte ou un quota API en fonction du point de terminaison et du modèle activé. Certains points de terminaison facturent lorsqu'une tâche est acceptée ; d'autres facturent lorsque la génération de médias réussit. Votre intégration doit afficher un état de nouvelle tentative clair et ne doit pas supposer que chaque demande échouée coûte des crédits.

Pour les flux de travail sensibles au solde, appelez Profil avant de démarrer des lots importants et une fois les tâches importantes terminées. Les tâches de longue durée doivent également conserver l'ID de tâche renvoyé afin que vous puissiez récupérer après le redémarrage du client sans créer de travail en double.

Compatibilité

Les anciens chemins Open API restent disponibles pendant la fenêtre de compatibilité, mais les nouvelles intégrations doivent utiliser /api/open/v1. Le guide de migration répertorie les remplacements de chemins connus et l'ordre de déploiement.

Les documentaires étrangers utilisent intentionnellement leurs propres voies actuelles. Si vous intégrez le site global, suivez les chemins sous https://fishaudio.org/api/open/v1 et confirmez les nouvelles surfaces avec GET /api/openapi.json.

Référence API