Zum Hauptinhalt springen
GET
/
v1
/
user
/
balance
curl --request GET \
  --url 'https://api.apimart.ai/v1/user/balance' \
  --header 'Authorization: Bearer <token>'

{
  "success": true,
  "remain_balance": 100.0,
  "used_balance": 25.5,
  "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.

Rufen Sie das verbleibende und das verbrauchte Guthaben des aktuellen Nutzerkontos ab. Dieser Endpunkt liefert Guthabeninformationen auf Nutzerebene, unabhängig von einzelnen Tokens, und dient zur Anzeige des Gesamtguthabens des Kontos. 
curl --request GET \
  --url 'https://api.apimart.ai/v1/user/balance' \
  --header 'Authorization: Bearer <token>'

{
  "success": true,
  "remain_balance": 100.0,
  "used_balance": 25.5,
  "unlimited_quota": false
}

​
Autorisierung

​
Authorization
string
erforderlich
Alle API-Endpunkte erfordern eine Authentifizierung per Bearer TokenSo erhalten Sie Ihren API-Key:Besuchen Sie die API-Key-Verwaltungsseite, um Ihren API-Key zu erhaltenFügen Sie ihn dem Request-Header hinzu:
Authorization: Bearer YOUR_API_KEY

​
Endpunkte

GET /v1/user/balance
GET /user/balance
Beide Endpunkte haben dieselbe Funktionalität — Sie können einen davon nach Belieben verwenden.

​
Antwort

​
success
boolean
Gibt an, ob die Anfrage erfolgreich war
​
message
string
Fehlermeldung (wird nur im Fehlerfall zurückgegeben)
​
remain_balance
float
Verbleibendes Guthaben des Nutzers (wird bei Erfolg zurückgegeben). Gibt -1 zurück, wenn unlimited_quota true ist
​
used_balance
float
Verbrauchtes Guthaben des Nutzers (wird bei Erfolg zurückgegeben)
​
unlimited_quota
boolean
Gibt an, ob der Nutzer über ein unbegrenztes Kontingent verfügt. true bedeutet unbegrenzt, false bedeutet begrenzt

​
Token-Guthaben vs. Nutzerguthaben

VergleichToken-Guthaben (/v1/balance)Nutzerguthaben (/v1/user/balance)
GeltungsbereichEinzelner TokenGesamtes Nutzerkonto
DatenquelleRemainQuota und UsedQuota des Tokensquota und used_quota des Nutzers
AnwendungsfallNutzung eines einzelnen API-Keys überwachenGesamtkontostand einsehen
Beschränkt durchToken-KontingentgrenzenNutzer-Kontingentgrenzen

​
Anwendungsfälle

  • Gesamtguthaben des Nutzerkontos einsehen
  • Aufladeerinnerungen und Guthabenwarnungen einrichten
  • Kontostand im Nutzer-Dashboard anzeigen
Hinweise zur GuthabeneinheitDie Einheit des Guthabenwerts hängt von der Systemkonfiguration ab:
  • USD – US-Dollar
  • CNY – Chinesische Yuan
  • Tokens – Token-Anzahl
Nutzer mit unbegrenztem KontingentWenn ein Nutzer mit einem unbegrenzten Kontingent eingerichtet ist:
  • Das Feld unlimited_quota gibt true zurück
  • Das Feld remain_balance gibt -1 zurück
  • Der Nutzer unterliegt keinen Kontingentbeschränkungen und kann die API ohne Limits verwenden

​
Häufige Fehler

FehlermeldungUrsacheLösung
No Authorization headerAuthorization-Header nicht angegebenHeader Authorization: Bearer sk-xxxxx hinzufügen
Failed to get user quotaNutzer existiert nichtPrüfen Sie, ob der zum Token gehörende Nutzer existiert
Failed to get used quotaFehler bei DatenbankabfrageWenden Sie sich an den Administrator, um den Systemstatus zu prüfen
SicherheitshinweisIhr API-Key ist wie ein Passwort. Bewahren Sie ihn sicher auf und geben Sie ihn nicht an andere weiter. Verwenden Sie in Produktivumgebungen stets HTTPS.