API कुंजी

मौजूदा API कुंजी की जानकारी पाएं

Authorization हेडर में मौजूद कुंजी की स्थिति, सीमा, शेष राशि, रीसेट अवधि, समाप्ति, कुंजी प्रकार, सफल अनुरोधों का खर्च और count, तथा rate tier लौटाता है। सामान्य कुंजी usage_scope: key के साथ केवल अपनी जानकारी लौटाती है; संगठन की Management Key usage_scope: organization के साथ पूरे संगठन की जानकारी लौटाती है और कुल संख्या संगठन डैशबोर्ड जैसी ही होती है। दिन, सप्ताह और महीने की सीमाएँ UTC पर आधारित हैं: 00:00 UTC, सोमवार 00:00 UTC और महीने के पहले दिन 00:00 UTC। संगठन की कुंजी पर अलग सीमा न होने पर limit_remaining, is_free_tier और rate tier संगठन के balance से आते हैं। खाते का balance देखने के लिए GET /v1/credits का उपयोग करें। नीचे का उदाहरण management key से पहले संगठन का कुल और फिर हर कुंजी का उपयोग दिखाता है। अलग सीमा होने पर limit_remaining दिन, सप्ताह या महीने की रीसेट अवधि में कुंजी के खर्च को सीमा से घटाने के बाद का मान है; अलग सीमा न होने पर कुंजी द्वारा उपयोग किया जाने वाला account balance, और संगठन की कुंजी के लिए organization balance लिया जाता है।

GET/v1/key

प्राधिकरण

Authorizationआवश्यक

string · header

Authorization हेडर में bearer token के रूप में 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."
    }
  }
}