API कुंजियां

परिचय

API कुंजियां ElevenLabs API के लिए आपके अनुरोधों को ऑथेंटिकेट करती हैं और आपके वर्कस्पेस के कोटा के आधार पर उपयोग ट्रैक करती हैं। ये दो प्रकार की होती हैं:

• यूज़र API कुंजियां किसी एक यूज़र की होती हैं और वर्कस्पेस संसाधनों के लिए उस यूज़र का एक्सेस इनहेरिट करती हैं। वे निजी डेवलपमेंट और स्क्रिप्ट्स के लिए उपयुक्त हैं, और उन्हें एक्सपायरी दी जा सकती है, ताकि वे तय अवधि के बाद अपने-आप काम करना बंद कर दें। चूंकि वे किसी व्यक्ति से जुड़ी होती हैं, इसलिए यूज़र API कुंजी उस यूज़र के एक्सेस बदलने या उनके वर्कस्पेस छोड़ने पर प्रभावित होती है। निजी API कुंजियां बनाने के लिए Full Seat चाहिए।
• सर्विस अकाउंट API कुंजियां किसी व्यक्ति की बजाय सर्विस अकाउंट की होती हैं, इसलिए व्यक्तिगत सदस्यता में बदलाव होने पर भी वे काम करती रहती हैं। इन्हें बैकएंड सिस्टम, ऑटोमेशन और प्रोडक्शन वर्कलोड के लिए सुझाया जाता है। सर्विस अकाउंट मल्टी-सीट ग्राहकों के लिए उपलब्ध हैं और वर्कस्पेस एडमिन इन्हें मैनेज करते हैं।

आपकी API कुंजी एक सीक्रेट है। इसे दूसरों के साथ शेयर न करें और क्लाइंट-साइड कोड (ब्राउज़र, ऐप्स) में एक्सपोज़ न करें। अनुरोध के साथ अपनी कुंजी भेजने का तरीका जानने के लिए API ऑथेंटिकेशन रेफरेंस देखें।

दोनों प्रकार की कुंजियों को कई तरीकों से प्रतिबंधित किया जा सकता है:

1. स्कोप प्रतिबंध: कुंजी किन API एंडपॉइंट्स को एक्सेस कर सकती है, इसे सीमित करें।
2. क्रेडिट कोटा: उपयोग नियंत्रित करने के लिए कस्टम क्रेडिट सीमा तय करें।
3. IP अलाउलिस्टिंग: कुंजी को खास IP पतों या CIDR रेंज तक सीमित करें। IP अलाउलिस्टिंग देखें।

एक्सपायर होने वाली यूज़र API कुंजियां

यूज़र API कुंजियों को एक्सपायरी दी जा सकती है, ताकि वे तय अवधि के बाद अपने-आप काम करना बंद कर दें। इससे लीक हुई या भूली हुई कुंजी के उपयोग की अवधि सीमित होती है और यह किसी व्यक्ति से जुड़ी कुंजियों के कम समय तक उपयोग होने के अनुरूप है।

अपनी निजी API कुंजी सेटिंग्स से कुंजी बनाते या संपादित करते समय एक्सपायरी तय करें। 15 मिनट से 30 दिन तक का प्रीसेट चुनने के लिए Expire After सेलेक्टर का उपयोग करें, या इसे Never (डिफ़ॉल्ट) पर छोड़ दें। Expires कॉलम बताता है कि हर कुंजी कब एक्सपायर होगी।

कुंजी की एक्सपायरी बीतने के बाद वह ऑथेंटिकेट करना बंद कर देती है और उससे किए गए अनुरोध 401 एरर के साथ अस्वीकार हो जाते हैं। कुंजी एक्सपायर होने से पहले उसे संपादित करके एक्सपायरी बढ़ा या हटा सकते हैं; अन्यथा, नई कुंजी पर रोटेट करें।

API कुंजियां रोटेट करना

दोनों मामलों में रोटेशन का पैटर्न एक ही है: नई कुंजी बनाएं, अपने ऐप्लिकेशन को उस पर स्विच करें, फिर पुरानी कुंजी हटा दें।

यूज़र API कुंजियां डैशबोर्ड से रोटेट की जाती हैं। अपनी निजी API कुंजी सेटिंग्स खोलें, नई कुंजी बनाएं, और स्विच करने के बाद पुरानी कुंजी हटा दें।

सर्विस अकाउंट API कुंजियां डैशबोर्ड से या API के ज़रिए रोटेट की जा सकती हैं:

• डैशबोर्ड में, ऊपर दाएं कोने में अपने प्रोफ़ाइल आइकन पर क्लिक करें, Workspace settings चुनें, और Service Accounts टैब खोलें। उसी सर्विस अकाउंट के लिए नई कुंजी बनाएं, फिर स्विच करने के बाद पुरानी कुंजी हटा दें।
• API के ज़रिए, उसी सर्विस अकाउंट के लिए नई कुंजी बनाएं, फिर पुरानी कुंजी हटाएं।

IP अलाउलिस्टिंग

आप API कुंजी को इस तरह सीमित कर सकते हैं कि वह केवल खास IP पतों या CIDR रेंज से काम करे। किसी अन्य IP से किए गए अनुरोध 403 एरर के साथ अस्वीकार हो जाएंगे।

समर्थित फ़ॉर्मैट

• अलग-अलग IPv4 पते (जैसे 203.0.113.10)
• अलग-अलग IPv6 पते (जैसे 2001:db8::1)
• CIDR रेंज (जैसे 203.0.113.0/24)

आप हर API कुंजी में 1 से 100 एंट्री जोड़ सकते हैं। बिना रेंज वाले IP पते अपने-आप /32 (IPv4) या /128 (IPv6) में नॉर्मलाइज़ हो जाते हैं।

लीक हुई कुंजियों का पता लगाना

ElevenLabs GitHub के सीक्रेट स्कैनिंग पार्टनर प्रोग्राम में भाग लेता है। अगर कोई ElevenLabs API कुंजी किसी पब्लिक GitHub रिपॉज़िटरी में कमिट की जाती है, तो GitHub ElevenLabs को सूचित करता है और अनधिकृत उपयोग रोकने के लिए कुंजी अपने-आप बंद हो जाती है।

इस तरह बंद की गई कुंजी का disable_reason, exposed_publicly होता है। एक्सेस बहाल करने के लिए, कुंजी रोटेट करें और अपने ऐप्लिकेशन को नई कुंजी इस्तेमाल करने के लिए अपडेट करें।

किसी कुंजी को खुद बंद करना

अगर आपको लगता है कि कोई कुंजी कॉम्प्रोमाइज़ हो गई है, तो कुंजी धारक Disable API key एंडपॉइंट से उसे सीधे बंद कर सकता है। इसे क्वेरी पैरामीटर api_key_name=self के साथ कॉल करें, जो स्पष्ट पुष्टि के लिए ज़रूरी है कि आप अनुरोध को ऑथेंटिकेट करने में इस्तेमाल हुई कुंजी को बंद करना चाहते हैं।

कुंजियां कौन बंद कर सकता है नियंत्रित करना

third_party_disable_allowed सेटिंग नियंत्रित करती है कि कुंजी को उसका धारक बंद कर सकता है या नहीं—सेल्फ-डिसेबल एंडपॉइंट से या उसके पब्लिक रूप से लीक होने पर अपने-आप। डिफ़ॉल्ट रूप से, यह नॉन-एंटरप्राइज़ प्लान के लिए सक्षम और एंटरप्राइज़ प्लान के लिए बंद होता है।

हर कुंजी के लिए: सर्विस अकाउंट API कुंजी बनाते या अपडेट करते समय third_party_disable_allowed सेट करें। वर्कस्पेस डिफ़ॉल्ट इस्तेमाल करने के लिए इसे छोड़ दें, या किसी अलग कुंजी को वर्कस्पेस डिफ़ॉल्ट पर रीसेट करने के लिए अपडेट में clear पास करें।

पूरे वर्कस्पेस के लिए: वर्कस्पेस एडमिन Set workspace third-party disabling policy एंडपॉइंट का उपयोग करके सभी कुंजियों की सेटिंग एक साथ ओवरराइड कर सकते हैं:

• true वर्कस्पेस की हर कुंजी को उसके धारक द्वारा बंद करने की अनुमति देता है।
• false हर कुंजी के लिए इसकी अनुमति नहीं देता।
• null वर्कस्पेस-व्यापी ओवरराइड हटा देता है, जिससे हर कुंजी का अपना मान और प्लान डिफ़ॉल्ट फिर से लागू होते हैं।