Fish Audio Docs
Référence API
Back to site

Profil

Lisez et mettez à jour le profil et le quota du compte Open API.

Profil

Utilisez les points de terminaison du profil pour inspecter l'identifiant de compte, le niveau, les crédits et le quota API restant du propriétaire de la clé API. Appelez ce point de terminaison avant des lots volumineux, après des tâches importantes et pendant les contrôles opérationnels.

Obtenir un profil

GET /api/open/v1/profile
Authorization: Bearer FISHAUDIO_API_KEY

Demande

La demande ne nécessite pas de corps.

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

Réponse

{
  "user_id": "user_123",
  "api_quota_remaining": 988000,
  "tier": "pro",
  "credits": 1200
}

Traitez les champs inconnus comme additifs et évitez de faire échouer les analyseurs stricts lorsque la réponse obtient de nouvelles métadonnées de compte ou de facturation.

Mettre à jour le profil

POST /api/open/v1/profile
Authorization: Bearer FISHAUDIO_API_KEY
Content-Type: application/json
{
  "webhookUrl": "https://example.com/webhooks/fishspeech"
}

Les champs actualisables sont contrôlés par le serveur. Les champs inconnus peuvent être ignorés ou rejetés. Séparez les mises à jour de profil de la création de tâches multimédias afin qu'une erreur de validation de profil ne puisse pas bloquer un travail de génération non lié.

Facturation et crédits

Le point de terminaison du profil constitue la vérification légère la plus sûre avant un lot. Il peut indiquer si le compte disposera probablement de suffisamment de crédits ou de quota pour la prochaine opération, mais ce n'est pas un système de réservation. Entre votre chèque et la demande des médias, d'autres travailleurs peuvent consommer le solde.

Pour les flux de travail critiques, stockez l’instantané de profil avec l’ID de lot. Si une tâche échoue ultérieurement pour des raisons de quota, cet instantané vous aide à distinguer un solde faible préexistant d'une utilisation simultanée par un autre processus.

Erreurs

StatutSignificationActions
401La clé API ne peut pas être authentifiéeArrêtez le travail et actualisez la clé API côté serveur
402Le compte est valide mais les contrôles de quota échouent pour une opération associéeAfficher un état de facturation ou de recharge
500Le service de profil a échouéRéessayez un petit nombre de fois avec backoff