API ouverte

Consulter son solde avec une clé API

Consultez le quota restant de la clé courante avec une clé API sk- : GET /v1/user/balance renvoie is_active / balance / unit, et GET /v1/credits renvoie total_credits / total_usage au format OpenRouter. Compatible avec l'interrogation périodique de clients tiers comme cc-switch.

Avec une clé API commençant par sk-, consultez directement le quota restant et la disponibilité de cette clé. Conçu pour les clients tiers qui affichent un solde dans leur interface, ou pour les scripts qui surveillent le solde.

Ces endpoints sont en lecture seule : ils ne sont pas facturés et ne consomment pas de quota. L'authentification ne valide que la clé elle-même : vous pouvez donc toujours lire le quota restant même lorsqu'il est épuisé et que les appels métier seraient rejetés (dans ce cas, is_active vaut false).


1. Vue d'ensemble des endpoints

EndpointFormat de client pris en chargeRenvoie
GET /v1/user/balanceModèle générique de solde de cc-switchis_active / balance / unit, plus used / total si la clé possède un quota total
GET /user/balanceIdentique ci-dessus, pour une Base URL sans /v1Identique à la ligne précédente
GET /v1/creditsStyle OpenRouterdata.total_credits / data.total_usage
ÉlémentValeur
Base URLhttps://api.lmuai.com
AuthentificationAuthorization: Bearer <sk-...>
Format de réponseJSON
Connexion requiseNon, la clé API suffit

/user/balance est un alias de /v1/user/balance (utilisé lorsque la Base URL du client est configurée sans /v1). /v1/credits n'a pas d'alias à la racine et doit inclure /v1.


2. Quel solde est renvoyé

balance n'est pas forcément le solde du portefeuille du compte : c'est le quota restant réellement disponible pour la clé courante, résolu dans cet ordre :

OrdreSituation de la cléSignification de balance
1La clé possède son propre quota totalLe quota restant de cette clé (total - used)
2La clé appartient à un groupe d'abonnementLe quota restant de l'abonnement (unit vaut requests lorsque le décompte se fait par requête)
3Aucun des deuxLe solde du portefeuille du compte

De plus, is_active indique si la clé peut actuellement être utilisée pour des appels métier : true lorsque la clé est active, non expirée et que son quota total n'est pas épuisé ; false également lorsque la clé appartient à un groupe d'abonnement sans abonnement actif.


3. GET /v1/user/balance

GET /v1/user/balance HTTP/1.1
Host: api.lmuai.com
Authorization: Bearer sk-xxxxxxxx

Réponse — mode solde du portefeuille (la clé n'a pas de quota et n'est pas dans un groupe d'abonnement) :

{
  "is_active": true,
  "balance": 1575.13,
  "unit": "USD"
}

Réponse — la clé possède un quota total (dans ce cas, used et total sont également renvoyés) :

{
  "is_active": true,
  "balance": 6,
  "unit": "USD",
  "used": 4,
  "total": 10
}

Réponse — groupe d'abonnement décompté par requête :

{
  "is_active": true,
  "balance": 842,
  "unit": "requests"
}

Champs de la réponse

ChampTypeDescription
is_activeboolSi la clé peut actuellement être utilisée pour des appels métier
balancenumberQuota restant ; voir unit pour l'unité
unitstringUSD (par défaut), ou requests pour les groupes d'abonnement décomptés par requête
usednumberPrésent uniquement lorsque la clé possède un quota total : quota déjà utilisé par cette clé
totalnumberPrésent uniquement lorsque la clé possède un quota total : quota total de cette clé

used / total n'ont de valeur significative qu'en mode quota par clé. Les modes solde du portefeuille et abonnement ne renvoient pas ces champs — utilisez balance et ne le déduisez pas de total - used.


4. GET /v1/credits

Format de solde de style OpenRouter ; les clients affichent le quota restant comme total_credits - total_usage.

GET /v1/credits HTTP/1.1
Host: api.lmuai.com
Authorization: Bearer sk-xxxxxxxx

Réponse :

{
  "data": {
    "total_credits": 20,
    "total_usage": 4
  }
}
ChampTypeDescription
data.total_creditsnumberUtilisé + restant, de sorte que total_credits - total_usage soit exactement le quota restant
data.total_usagenumberQuota déjà utilisé

total_credits est une valeur composite « utilisé + restant » — ce n'est pas la valeur littérale de la limite de quota. En mode solde du portefeuille, total_usage vaut 0 et total_credits équivaut au solde ; lorsque le quota est épuisé, le quota restant est ramené à 0, donc total_credits équivaut alors à la quantité utilisée.


5. Configuration dans les clients tiers

Client / scénarioConfiguration
Modèle générique de solde de cc-switchLa Base URL https://api.lmuai.com (sans /v1) ou https://api.lmuai.com/v1 (avec /v1) fonctionnent toutes deux
Clients compatibles OpenRouter (Kelivo, RikkaHub, etc.)Base URL https://api.lmuai.com/v1 ; le client demandera /v1/credits
Script personnelAppelez directement /v1/user/balance ; ses champs sont plus faciles à lire
curl -s https://api.lmuai.com/v1/user/balance \
  -H "Authorization: Bearer sk-xxxxxxxx"

6. Réponses d'erreur

La consultation du solde utilise l'authentification standard par clé API de la passerelle : les erreurs ont donc le même format que pour les autres appels à l'API. Lorsque la requête ne contient pas de clé :

{
  "code": "API_KEY_REQUIRED",
  "message": "API key is required in Authorization header (Bearer scheme), x-api-key header, or x-goog-api-key header"
}
Code de statutcodeScénario
200—Réponse normale ; un quota épuisé, une clé expirée ou un abonnement absent renvoient aussi 200, avec is_active: false pour indiquer que la clé est inutilisable
401API_KEY_REQUIREDLa requête ne contient pas de clé API
401INVALID_API_KEYLa clé n'existe pas ou est mal formée
401API_KEY_DISABLEDLa clé a été désactivée
403ACCESS_DENIEDLa clé a une liste d'IP autorisées / bloquées et l'IP actuelle n'est pas autorisée

Pour les erreurs générales, consultez Codes d'erreur.


7. Différence avec « Exporter les détails d'utilisation »

Les endpoints de solde de cette pageExporter les détails d'utilisation
AuthentificationClé API sk-Compte et mot de passe échangés contre un JWT
GranularitéQuota restant de la clé couranteDétails par requête au niveau du compte
Cas d'usageAffichage du solde dans un client, surveillance du soldeExport de factures, rapprochement, alimentation d'un BI

GET /v1/usage se situe entre les deux : il accepte également une clé sk- et renvoie les statistiques d'utilisation du jour et cumulées ainsi que les informations de quota de la clé courante, avec des champs plus détaillés.

Dernière mise à jour :

京ICP备2020034311号-7

Sur cette page