Zum Hauptinhalt springen
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.

Rufen Sie das verbleibende und verbrauchte Guthaben des aktuellen API-Keys (Tokens) ab. Dieser Endpunkt dient zur Überwachung der Nutzung eines einzelnen Tokens. 
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
}

​
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/balance
GET /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 Tokens (wird bei Erfolg zurückgegeben). Gibt -1 zurück, wenn unlimited_quota true ist
​
used_balance
float
Verbrauchtes Guthaben des Tokens (wird bei Erfolg zurückgegeben)
​
unlimited_quota
boolean
Gibt an, ob der Token über ein unbegrenztes Kontingent verfügt. true bedeutet unbegrenzt, false bedeutet begrenzt

​
Anwendungsfälle

  • Verbrauch eines einzelnen API-Keys überwachen
  • Aktuellen Token-Kontostand in Ihrer Anwendung anzeigen
  • Guthabenwarnungen einrichten, wenn der Kontostand unter einen Schwellenwert fällt
Hinweise zur GuthabeneinheitDie Einheit des Guthabenwerts hängt von der Systemkonfiguration ab:
  • USD – US-Dollar
  • CNY – Chinesische Yuan
  • Tokens – Token-Anzahl
Token mit unbegrenztem KontingentWenn für einen Token ein unbegrenztes Kontingent festgelegt ist:
  • Das Feld unlimited_quota gibt true zurück
  • Das Feld remain_balance gibt -1 zurück
  • Der Token unterliegt keinen Kontingentbeschränkungen und kann ohne Limits verwendet werden

​
Häufige Fehler

FehlermeldungUrsacheLösung
No Authorization headerAuthorization-Header nicht angegebenHeader Authorization: Bearer sk-xxxxx hinzufügen
Failed to get token infoToken existiert nicht oder wurde gelöschtPrüfen Sie, ob der Token-Key korrekt ist
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.