API Balance

Vérifiez combien de crédits vous pouvez dépenser, et combien d'entre eux expirent lors du prochain renouvellement mensuel.

GET/openapi/v1/balance

Obtenir le solde

Renvoie le solde de crédits du compte propriétaire de la clé API. Pour une équipe disposant d'un pool de crédits partagé, les valeurs sont celles du pool. L'appel à ce point de terminaison est gratuit.

Request

GET

/openapi/v1/balance

curl https://api.meshy.ai/openapi/v1/balance \
-H "Authorization: Bearer ${YOUR_API_KEY}"

Response

{
  "balance": 1000,
  "monthly_credits": 600,
  "permanent_credits": 400,
  "monthly_resets_at": 1793491200000
}

Valeurs renvoyées

Name
balance
Type
integer
Description
Nombre de crédits que vous pouvez dépenser. Il s'agit généralement de monthly_credits plus permanent_credits.
Il peut être inférieur si une limite de crédits par membre ou une limite de crédits d'espace de travail Enterprise s'applique à vous. Les propriétaires et administrateurs d'équipe n'ont pas une telle limite.
Name
monthly_credits
Type
integer
Description
Nombre de crédits restants qui expirent lors du prochain renouvellement mensuel, à monthly_resets_at.
Name
permanent_credits
Type
integer
Description
Nombre de crédits qui n'expirent pas, par exemple issus des packs de crédits que vous avez achetés et des récompenses.
Name
monthly_resets_at
Type
timestamp
Description
Heure du prochain renouvellement mensuel des crédits, en millisecondes Unix. À ce moment-là, les crédits mensuels restants expirent, et un abonnement actif les recharge. null lorsqu'aucun renouvellement n'est prévu.

Modes d'échec

Name
401 - Unauthorized
Description
La clé API est manquante ou invalide. Vérifiez l'en-tête Authorization.
Name
429 - Too Many Requests
Description
Vous avez envoyé trop de requêtes. Attendez le nombre de secondes indiqué dans Retry-After, puis réessayez.