Guthabenabfrage

Gibt den Guthabenstatus des Kontos zurück, dem der aktuelle API-Schlüssel gehört — verfügbares Guthaben, kumulierte Aufladungen und kumulierte Ausgaben.

Dieser Endpunkt gehört zur OfoxAI OpenAPI und ist protokollunabhängig (OpenAI / Anthropic / Gemini). Jeder gültige OfoxAI-API-Schlüssel kann ihn aufrufen; die Antwortstruktur ist kompatibel mit cc-switch und ähnlichen Drittanbieter-Tools.

Endpunkt


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

Derselbe Endpunkt wird auch über die Anthropic- / Gemini-Eingänge bereitgestellt — praktisch für Clients, die bereits eine andere Base URL konfiguriert haben:

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

Alle drei URLs liefern identische Antwortstrukturen.

Authentifizierung

Übergeben Sie einen gültigen OfoxAI-API-Schlüssel (sk-...) über den Authorization: Bearer-Header:


Authorization: Bearer sk-xxx

Verwenden Sie einen Benutzer-API-Schlüssel (im Dashboard erstellt). Verwenden Sie keine internen Internal / Gateway-Schlüssel.

Anfragebeispiel

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"Verfügbares Guthaben: ${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(`Verfügbares Guthaben: $${data.balance.toFixed(4)} ${data.currency}`)

Antwortformat

Erfolgsantwort 200 OK:


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

Antwortfelder

Feld	Typ	Beschreibung
`is_active`	boolean	Ob das Konto nutzbar ist. `true` nach erfolgreicher Authentifizierung; `false` bei Fehler
`balance`	number	Aktuell verfügbares Guthaben, gleich `total - used`
`total`	number	Kumulierte Aufladungen: Aufladungen + Boni + Geschenkkarten
`used`	number	Kumulierte Ausgaben: Gesamtverbrauch aller Aufrufe
`currency`	string	Währung, fest auf `"USD"`

Alle Beträge in USD als 64-Bit-Gleitkommazahlen. Intern wird mit NanoDollar-Präzision (10⁻⁹ USD) verfolgt — genau bis in den Sub-Cent-Bereich.

Fehlerantwort

Bei Authentifizierungsfehler oder Service-Fehler wird ein Statuscode ungleich 200 mit einem cc-switch-kompatiblen Body zurückgegeben:


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

Status	`error`-Wert	Beschreibung
`401`	`unauthenticated`	API-Schlüssel ungültig, deaktiviert oder abgelaufen
`500`	`internal error`	Interner Service-Fehler, bitte später erneut versuchen

Kompatibilität mit Drittanbieter-Tools

Die Antwortstruktur ist kompatibel mit dem Guthabenabfrage-Template von cc-switch und funktioniert als direkter Guthabenanbieter für cc-switch:

is_active für Statusprüfung
balance entspricht dem remaining-Feld von cc-switch
total / used für Verbrauchsfortschrittsanzeige