API 키

현재 API 키 정보 조회

Authorization 헤더의 키 상태, 한도, 남은 금액, 재설정 주기, 만료, 키 유형, 성공한 요청의 사용액과 횟수, 속도 등급을 반환합니다. 일반 키는 usage_scope: key로 해당 키 자체의 값을 반환하고, 조직 Management Key는 usage_scope: organization으로 조직 전체의 값을 반환합니다. 조직 전체 합계는 조직 대시보드와 같습니다. 일·주·월 경계는 UTC 기준으로 매일 00:00, 월요일 00:00, 매월 1일 00:00에 시작합니다. 조직 키에 개별 한도가 없으면 limit_remaining, is_free_tier, 속도 등급은 조직 잔액을 사용합니다. 계정 잔액은 GET /v1/credits를 사용하세요. 아래 예시는 management key로 조직 총액을 확인한 뒤 각 키의 사용량을 확인합니다. 개별 한도가 있으면 limit_remaining은 일·주·월 재설정 주기 동안 이 키가 사용한 금액을 한도에서 뺀 값입니다. 개별 한도가 없으면 키가 사용하는 계정 잔액을 사용하고, 조직 키는 조직 잔액을 사용합니다.

GET/v1/key

인증

Authorization필수

string · header

Authorization 헤더에 Bearer 토큰으로 API 키를 전달합니다.

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

응답 예시

성공. 일반 키의 usage_scope는 key이고 조직 Management Key의 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."
    }
  }
}