Passer au contenu principal
GET
/
v1
/
balance
curl --request GET \
  --url 'https://api.apimart.ai/v1/balance' \
  --header 'Authorization: Bearer <token>'

{
  "success": true,
  "remain_balance": 10.5,
  "used_balance": 2.3,
  "unlimited_quota": false
}

Documentation Index

Fetch the complete documentation index at: https://docs.apimart.ai/llms.txt

Use this file to discover all available pages before exploring further.

Obtenez le solde restant et le solde utilisé de la clé API (token) actuelle. Cet endpoint sert à surveiller l’utilisation d’un seul token. 
curl --request GET \
  --url 'https://api.apimart.ai/v1/balance' \
  --header 'Authorization: Bearer <token>'

{
  "success": true,
  "remain_balance": 10.5,
  "used_balance": 2.3,
  "unlimited_quota": false
}

​
Autorisation

​
Authorization
string
requis
Tous les endpoints API requièrent une authentification par Bearer TokenObtenez votre clé API :Rendez-vous sur la page de gestion des clés API pour obtenir votre clé APIAjoutez-la à l’en-tête de la requête :
Authorization: Bearer YOUR_API_KEY

​
Endpoints

GET /v1/balance
GET /balance
Les deux endpoints offrent les mêmes fonctionnalités ; vous pouvez utiliser l’un ou l’autre.

​
Réponse

​
success
boolean
Indique si la requête a réussi
​
message
string
Message d’erreur (renvoyé uniquement en cas d’échec)
​
remain_balance
float
Solde restant du token (renvoyé en cas de succès). Renvoie -1 lorsque unlimited_quota vaut true
​
used_balance
float
Solde utilisé du token (renvoyé en cas de succès)
​
unlimited_quota
boolean
Indique si le token dispose d’un quota illimité. true signifie illimité, false signifie limité

​
Cas d’usage

  • Surveiller la consommation d’une seule clé API
  • Afficher le solde actuel du token dans votre application
  • Configurer des alertes lorsque le solde passe sous un seuil
Informations sur l’unité du soldeL’unité de la valeur du solde dépend de la configuration du système :
  • USD — Dollars américains
  • CNY — Yuans chinois
  • Tokens — Nombre de tokens
Token à quota illimitéLorsqu’un token est configuré avec un quota illimité :
  • Le champ unlimited_quota renvoie true
  • Le champ remain_balance renvoie -1
  • Le token n’a aucune restriction de quota et peut être utilisé sans limite

​
Erreurs fréquentes

Message d’erreurCauseSolution
No Authorization headerEn-tête Authorization non fourniAjoutez l’en-tête Authorization: Bearer sk-xxxxx
Failed to get token infoLe token n’existe pas ou a été suppriméVérifiez que la clé du token est correcte
Note de sécuritéVotre clé API est comme un mot de passe. Conservez-la en sécurité et ne la partagez pas. Utilisez toujours HTTPS en production.