Aktuelle API-Schlüssel-Info abrufen

Gibt den Status des Schlüssels selbst zurück, entnommen aus dem Authorization-Header: dessen Ausgabenlimit und Restbetrag, Ablaufdatum, Schlüsseltyp, kumulierte/tägliche/wöchentliche/monatliche Ausgaben und Anfragenzahlen sowie sein Ratenlimit. limit/limit_remaining sind nur dann nicht null, wenn für diesen spezifischen Schlüssel ein eigenes Ausgabenlimit (spendLimitUsd) konfiguriert ist; andernfalls wird stattdessen das Kontoguthaben zurückgegeben.

GET/api/v1/key

Autorisierung

Authorizationerforderlich

string · header

API-Schlüssel als Bearer-Token im Authorization-Header.

GET /api/v1/key

1
2
curl https://bazaarlink.ai/api/v1/key \
  -H "Authorization: Bearer $BAZAARLINK_API_KEY"

Antwortbeispiele

Erfolg. is_management_key und is_provisioning_key sind zwei Namen für dasselbe zugrunde liegende Flag (passend zur eigenen Benennung dieser API und zum gebräuchlicheren Branchenbegriff), keine zwei unabhängigen Fähigkeiten.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
{
  "data": {
    "label": "default",
    "limit": 50,
    "limit_remaining": 42.5,
    "limit_reset": "month",
    "expires_at": null,
    "is_free_tier": false,
    "is_management_key": false,
    "is_provisioning_key": false,
    "usage": 128.4,
    "usage_daily": 1.2,
    "usage_weekly": 8.6,
    "usage_monthly": 27.9,
    "requests": 940,
    "requests_daily": 12,
    "requests_weekly": 88,
    "requests_monthly": 340,
    "rate_limit": {
      "requests": 200,
      "interval": "1m",
      "note": "Paid-tier rate limit."
    }
  }
}