Guide de migration
Passez des anciens chemins Open API à Open API v1.
Guide de migration
Les nouvelles intégrations devraient appeler /api/open/v1. Les anciens chemins restent disponibles pendant la fenêtre de compatibilité, mais ils ne doivent pas être utilisés pour de nouveaux travaux.
Cartographie du chemin
| Chemin hérité | Ouvrir le chemin API v1 |
|---|---|
POST /api/open/create-model | POST /api/open/v1/voices |
POST /api/open/delete-model | DELETE /api/open/v1/voices/{voiceId} |
POST /api/open/list-models | GET /api/open/v1/voices |
POST /api/open/lip-sync/create | POST /api/open/v1/media/lip-sync/jobs |
GET /api/open/lip-sync/list | GET /api/open/v1/media/lip-sync/jobs |
GET /api/open/lip-sync/query | GET /api/open/v1/media/lip-sync/jobs/{jobId} |
Confirmez les formes finales de demande et de réponse avec :
GET /api/openapi.jsonCommande recommandée
- Basculez d'abord les appels en lecture seule, tels que le profil, la liste vocale et l'état du travail.
- Déplacez les points de terminaison de création une fois que l’analyse des demandes et des réponses est couverte par les tests.
- Continuez à consigner l'ancien point de terminaison et le nouveau point de terminaison pendant le déploiement.
- Supprimez les chemins clients existants uniquement une fois que le trafic de production n'en dépend plus.
Demander des modifications
Utilisez l'authentification du porteur pour chaque requête v1.
Authorization: Bearer FISHAUDIO_API_KEYPréférez les identifiants stables dans les corps de requête. Pour TTS, envoyez l’identifiant vocal dans voiceId et l’identifiant du modèle du moteur TTS dans modelId. Seul reference_id reste un ancien alias de l’identifiant vocal.
Utilisez la voix du système public 00a1b221-6137-4b73-ad62-b0cbce134167 pour un petit test de migration, puis passez à l'ID vocal de production sélectionné par votre application.
Modifications de réponse
Les points de terminaison V1 sont conçus autour de ressources explicites : voix, tâches, tâches et enregistrements de profil. Mettez à jour votre client pour analyser les champs de réponse spécifiques au point de terminaison au lieu de dépendre d'une forme de wrapper globale.
Pour les opérations multimédias asynchrones, conservez immédiatement le travail ou l’ID de tâche renvoyé. Les interrogations, les tentatives et les enquêtes de support doivent utiliser cet identifiant.
Facturation et crédits
La migration elle-même ne modifie pas le solde du compte, mais les nouveaux points de terminaison peuvent exposer des champs de crédits et de quota plus clairs. Pendant le déploiement, comparez les anciens et les nouveaux chemins de code sur les petites tâches avant de déplacer un trafic volumineux.
Si une demande échoue pendant la migration, enregistrez le chemin existant, le nouveau chemin, le code d'état, API requestId et votre ID de tâche interne. Cela donne suffisamment de contexte sans exposer les clés API du porteur ou les URL de médias privés.