API Key

Dapatkan info API key saat ini

Mengembalikan status key pada header Authorization: batas, sisa saldo, periode reset, masa berlaku, jenis key, pengeluaran dan jumlah request yang berhasil, serta tingkat batas laju. Key biasa mengembalikan data miliknya sendiri dengan usage_scope: key; Management Key organisasi mengembalikan data seluruh organisasi dengan usage_scope: organization, menggunakan total yang sama seperti dashboard organisasi. Batas hari, minggu, dan bulan mengikuti UTC: 00:00 UTC, Senin 00:00 UTC, dan hari pertama bulan pada 00:00 UTC. Jika key organisasi tidak memiliki batas per-key, limit_remaining, is_free_tier, dan tingkat laju menggunakan saldo organisasi. Gunakan GET /v1/credits untuk saldo akun. Contoh di bawah memakai management key untuk melihat total organisasi lalu penggunaan setiap key. Jika ada batas per-key, limit_remaining adalah batas dikurangi pengeluaran key dalam periode reset harian, mingguan, atau bulanan; tanpa batas per-key, digunakan saldo akun yang dipakai key tersebut, sedangkan key organisasi menggunakan saldo organisasi.

GET/v1/key

Otorisasi

Authorizationwajib

string · header

API key sebagai bearer token di header Authorization.

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"}]}

Contoh respons

Berhasil. Key biasa memiliki usage_scope: key; Management Key organisasi memiliki 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."
    }
  }
}