Dapatkan satu API key

Mengambil satu API key dalam cakupan yang dapat dilihat pemanggil. Dengan Management Key organisasi, ID harus berada di organisasi milik key tersebut; key pribadi pemilik dan key dari organisasi lain sama-sama mengembalikan 404 tanpa membocorkan keberadaannya. Bentuk respons adalah { data: <key>, key: <key> } dengan objek yang sama di kedua field. <key> berisi limit, limit_remaining, limit_reset, usage, usage_daily/weekly/monthly, requests, requests_daily/weekly/monthly, dan usage_scope: key. Angka penggunaan sama dengan GET /v1/key saat dipanggil menggunakan key tersebut. limit_remaining adalah batas dikurangi pengeluaran key pada periode reset; tanpa batas per-key, nilainya adalah saldo akun atau organisasi yang digunakan key. Secret mentah tidak dikembalikan.

GET/v1/keys/:id

Otorisasi

Authorizationwajib

string · header

API key sebagai bearer token di header Authorization.

Parameter path

idwajib

string

ID API key yang akan diambil.

GET /v1/keys/:id

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

Contoh respons

Berhasil. data dan key berisi objek key yang sama, dan usage_scope selalu key.

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
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
  "data": {
    "id": "key_demo_01",
    "name": "worker-a",
    "keyPrefix": "demo_",
    "keySuffix": "01",
    "enabled": true,
    "keyType": "standard",
    "limit": 10,
    "limit_remaining": 7.88,
    "limit_reset": "day",
    "usage": 24.41,
    "usage_daily": 2.12,
    "usage_weekly": 5.64,
    "usage_monthly": 9.37,
    "requests": 314,
    "requests_daily": 18,
    "requests_weekly": 61,
    "requests_monthly": 205,
    "usage_scope": "key",
    "spendLimitUsd": 10,
    "spendLimitPeriod": "day",
    "organizationId": "org_demo_01",
    "expiresAt": null
  },
  "key": {
    "id": "key_demo_01",
    "name": "worker-a",
    "keyPrefix": "demo_",
    "keySuffix": "01",
    "enabled": true,
    "keyType": "standard",
    "limit": 10,
    "limit_remaining": 7.88,
    "limit_reset": "day",
    "usage": 24.41,
    "usage_daily": 2.12,
    "usage_weekly": 5.64,
    "usage_monthly": 9.37,
    "requests": 314,
    "requests_daily": 18,
    "requests_weekly": 61,
    "requests_monthly": 205,
    "usage_scope": "key",
    "spendLimitUsd": 10,
    "spendLimitPeriod": "day",
    "organizationId": "org_demo_01",
    "expiresAt": null
  }
}