API कुंजी बनाएँ
एक नई मानक API कुंजी (या एक और प्रबंधन कुंजी) बनाता है। यह एक प्रबंधन एंडपॉइंट है — यदि Bearer टोकन से प्रमाणित करते हैं, तो वह Management API Key होनी चाहिए, सामान्य sk-bl- कुंजी नहीं; लॉग इन सत्र cookie भी काम करता है। प्रतिक्रिया में key फ़ील्ड ही एकमात्र मौका है जब कच्चा कुंजी मान दिखता है — बाद में सिस्टम केवल हैश संग्रहीत करता है, इसे दोबारा प्राप्त नहीं किया जा सकता।
/api/v1/keysप्राधिकरण
Authorizationआवश्यकAuthorization हेडर में bearer token के रूप में API कुंजी।
Body
nameआवश्यककुंजी के लिए प्रदर्शन नाम; आगे/पीछे के रिक्त स्थान हटा दिए जाते हैं और परिणाम खाली नहीं हो सकता।
keyTypeकुंजी का प्रकार, डिफ़ॉल्ट standard है; "management" के अलावा कोई भी मान standard माना जाता है।
standardmanagement"standard"limitखर्च सीमा (USD), spendLimitUsd के रूप में संग्रहीत। null या छोड़ना कोई सीमा नहीं दर्शाता। सेट करते समय limit_reset भी देना ज़रूरी है। GET /v1/key यही मान limit फ़ील्ड में लौटाता है।
limit_resetखर्च सीमा की रीसेट अवधि, spendLimitPeriod के रूप में संग्रहीत। OR-संगत उपनाम (daily/weekly/monthly) या आंतरिक नाम (day/week/month) दोनों स्वीकार्य हैं — दोनों समान प्रभाव देते हैं।
dailyweeklymonthlydayweekmonth"monthly"expires_atकुंजी की समाप्ति समय, एक ISO दिनांक स्ट्रिंग जो भविष्य में होनी चाहिए। null या छोड़ना कभी समाप्त न होना दर्शाता है।
"2027-01-01T00:00:00Z"organizationIdकुंजी को व्यक्तिगत खाते के बजाय दिए गए संगठन से जोड़ता है। कॉलर को उस संगठन/टीम/सदस्य दायरे की प्राधिकरण जाँच पास करनी होगी, अन्यथा रिक्वेस्ट 400 लौटाती है।
teamIdकुंजी को संगठन के भीतर किसी विशिष्ट टीम तक और सीमित करता है। organizationId के साथ प्रयोग होता है।
orgMemberIdकुंजी को संगठन के भीतर किसी विशिष्ट सदस्य तक और सीमित करता है। organizationId के साथ प्रयोग होता है।