API-Schlüssel

Informationen zum aktuellen API-Schlüssel abrufen

Liefert den Status des Schlüssels im Authorization-Header: Limit, Restbetrag, Rücksetzzeitraum, Ablauf, Schlüsseltyp, Ausgaben und Anzahl erfolgreicher Anfragen sowie die Ratenlimit-Stufe. Ein gewöhnlicher Schlüssel liefert mit usage_scope: key nur seine eigenen Werte; ein Management Key einer Organisation liefert mit usage_scope: organization die Werte der gesamten Organisation. Diese Summe entspricht der Organisationsübersicht. Tages-, Wochen- und Monatsgrenzen verwenden UTC: 00:00 UTC, Montag 00:00 UTC und der erste Tag des Monats um 00:00 UTC. Wenn ein Organisationsschlüssel kein eigenes Limit hat, beziehen sich limit_remaining, is_free_tier und die Ratenlimit-Stufe auf das Organisationsguthaben. Für das Kontoguthaben ist GET /v1/credits vorgesehen. Das folgende Beispiel verwendet einen Management Key, um zuerst die Organisationssumme und danach die Nutzung jedes Schlüssels abzurufen. Bei einem eigenen Limit ist limit_remaining das Limit abzüglich der Ausgaben dieses Schlüssels im täglichen, wöchentlichen oder monatlichen Rücksetzzeitraum; ohne eigenes Limit wird das vom Schlüssel verwendete Kontoguthaben verwendet, bei Organisationsschlüsseln das Organisationsguthaben.

GET/v1/key

Autorisierung

Authorizationerforderlich

string · header

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

GET /v1/key

1
2
3
4
5
6
7
8
9
10
11
curl https://api.bazaarlink.ai/v1/key \
  -H "Authorization: Bearer $BAZAARLINK_MANAGEMENT_KEY"

# Abbreviated response (fake values):
# {"data":{"usage":18.42,"usage_scope":"organization","requests":73}}

curl https://api.bazaarlink.ai/v1/keys \
  -H "Authorization: Bearer $BAZAARLINK_MANAGEMENT_KEY"

# Abbreviated response (fake values):
# {"keys":[{"id":"key_demo_01","usage":7.12,"usage_scope":"key"}]}

Antwortbeispiele

Erfolg. Ein gewöhnlicher Schlüssel hat usage_scope: key; ein Organisations-Management-Key hat usage_scope: organization.

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
26
{
  "data": {
    "label": "team-management",
    "limit": null,
    "limit_remaining": 81.58,
    "limit_reset": null,
    "expires_at": null,
    "is_free_tier": false,
    "is_management_key": true,
    "is_provisioning_key": true,
    "usage": 18.42,
    "usage_daily": 2.14,
    "usage_weekly": 8.73,
    "usage_monthly": 18.42,
    "requests": 73,
    "requests_daily": 9,
    "requests_weekly": 31,
    "requests_monthly": 73,
    "usage_scope": "organization",
    "rate_limit": {
      "requests": 200,
      "interval": "1m",
      "note": "Paid-tier rate limit."
    }
  }
}