Consultation du solde

Renvoie l’état du solde du compte propriétaire de la clé API actuelle, incluant le solde disponible, les crédits cumulés et la consommation cumulée.

Cette route fait partie de l’OfoxAI OpenAPI et est indépendante du protocole (OpenAI / Anthropic / Gemini). Toute clé API OfoxAI valide peut l’appeler ; la structure de réponse est compatible avec cc-switch et autres outils tiers.

Endpoint


GET https://api.ofox.ai/v1/user/balance

La même route est également exposée via les entrées Anthropic / Gemini pour réutilisation par les clients déjà configurés avec une autre Base URL :

URL
`https://api.ofox.ai/v1/user/balance`
`https://api.ofox.ai/anthropic/user/balance`
`https://api.ofox.ai/gemini/user/balance`

Les trois URLs renvoient exactement la même structure de réponse.

Authentification

Passez toute clé API OfoxAI valide (sk-...) via l’en-tête Authorization: Bearer :


Authorization: Bearer sk-xxx

Utilisez une clé API de niveau utilisateur (créée dans le Dashboard ). N’utilisez pas les clés Internal / Gateway.

Exemple de requête

cURL

Terminal


curl https://api.ofox.ai/v1/user/balance \
  -H "Authorization: Bearer $OFOX_API_KEY"

Python

balance.py


import os
import requests
 
resp = requests.get(
    "https://api.ofox.ai/v1/user/balance",
    headers={"Authorization": f"Bearer {os.environ['OFOX_API_KEY']}"},
)
data = resp.json()
print(f"Solde disponible : ${data['balance']:.4f} {data['currency']}")

TypeScript

balance.ts


const resp = await fetch('https://api.ofox.ai/v1/user/balance', {
  headers: { Authorization: `Bearer ${process.env.OFOX_API_KEY}` },
})
const data = await resp.json()
console.log(`Solde disponible : $${data.balance.toFixed(4)} ${data.currency}`)

Format de réponse

Réponse réussie 200 OK :


{
  "is_active": true,
  "balance": 42.1357,
  "total": 100.0000,
  "used": 57.8643,
  "currency": "USD"
}

Champs de réponse

Champ	Type	Description
`is_active`	boolean	Si le compte est utilisable. `true` après authentification réussie ; `false` en cas d’échec
`balance`	number	Solde disponible actuel, égal à `total - used`
`total`	number	Crédits cumulés : rechargements + bonus + cartes cadeaux
`used`	number	Consommation cumulée : consommation totale de tous les appels
`currency`	string	Devise, fixée à `"USD"`

Tous les montants sont en USD sous forme de flottants 64 bits. La précision interne est en NanoDollar (10⁻⁹ USD), exacte jusqu’aux fractions de cent.

Réponse d’erreur

En cas d’échec d’authentification ou d’erreur du service, un code non-200 est renvoyé avec un corps compatible cc-switch :


{
  "error": "unauthenticated",
  "is_active": false
}

Statut	Valeur `error`	Description
`401`	`unauthenticated`	Clé API invalide, désactivée ou expirée
`500`	`internal error`	Erreur interne du service, veuillez réessayer

Compatibilité avec les outils tiers

La structure de réponse est compatible avec le modèle de consultation de solde de cc-switch et fonctionne directement comme fournisseur de solde pour cc-switch :

is_active pour la vérification du statut
balance correspond au champ remaining de cc-switch
total / used pour afficher la progression de la consommation