डेवलपर्स के लिए Codex API कुंजी की व्याख्या

API कुंजी फॉर्मेट को समझना

जब आप एक सेवा के लिए साइन अप करते हैं जो codex api key प्रदान करती है, तो आपको एक अद्वितीय अल्फान्यूमेरिक स्ट्रिंग मिलती है। यह कुंजी बैकएंड को भेजे जाने वाले हर अनुरोध के लिए आपकी प्रमाणीकरण क्रेडेंशियल के रूप में कार्य करती है। फॉर्मेट आमतौर पर एक मानक पैटर्न का पालन करता है, जैसे sk-... या प्रदाता के कार्यान्वयन के आधार पर समान उपसर्ग। हालांकि, चूंकि आप एक स्वतंत्र प्रॉक्सी का उपयोग कर रहे हैं, सटीक उपसर्ग भिन्न हो सकता है। महत्वपूर्ण कारक फॉर्मेट स्वयं नहीं है, बल्कि यह सुनिश्चित करना है कि कुंजी को HTTP Authorization हेडर में Bearer <your_key> के रूप में सही ढंग से पारित किया जाए।

आपकी API कुंजी एक विशिष्ट खाते और उपयोग टायर से जुड़ी होती है। कुछ सेवाओं के विपरीत जो विभिन्न वातावरणों (dev vs. prod) के लिए कई कुंजियाँ उत्पन्न करती हैं, हमारी सेटअप सरल है: एक खाता, एक कुंजी। यदि आप अपनी कुंजी खो देते हैं या संदेह होता है कि वह संक्रमित हो गई है, तो आप अपने डैशबोर्ड से तुरंत इसे पुनः उत्पन्न कर सकते हैं। यह पुरानी कुंजी को तुरंत अमान्य कर देता है, यह सुनिश्चित करते हुए कि कोई अनधिकृत एक्सेस बना न रहे। याद रखें कि कुंजियाँ बदलते समय अपने एन्वायरनमेंट वेरिएबल्स या कॉन्फ़िगरेशन फ़ाइलों को अपडेट करें।

सुरक्षा सर्वोत्तम अभ्यास

• अपनी कुंजी को एनवायरनमेंट वेरिएबल्स में स्टोर करें, अपने स्रोत कोड में नहीं।
• अपनी codex api key को सार्वजनिक रिपॉजिटरी में कभी न कमिट करें।
• यदि आप संदेह करते हैं कि कुंजी उजागर हो गई है, तो रीजेनरेट फ़ंक्शन का उपयोग करें।

सामान्य त्रुटि: 401 Unauthorized

401 Unauthorized त्रुटि नई API कुंजी एकीकृत करते समय सबसे सामान्य समस्या है। यह संकेत देता है कि सर्वर ने आपकी प्रमाणीकरण क्रेडेंशियल को अस्वीकार कर दिया है। claude code proxy या किसी भी OpenAI-संगत एंडपॉइंट के संदर्भ में, इसका लगभग हमेशा अर्थ होता है कि कुंजी गायब है, गलत है, या समाप्त हो चुकी है।

ट्रबलशूट करने के लिए, सबसे पहले सत्यापित करें कि आप कुंजी को बिल्कुल वैसे ही कॉपी कर रहे हैं जैसा प्रदान किया गया है। कुंजियाँ अक्सर केस-सेंसिटिव होती हैं और यदि गलत तरीके से कॉपी की जाएं तो उनमें स्पेस हो सकते हैं। सुनिश्चित करें कि आप अपने क्षेत्र या सेवा टायर के लिए सही बेस URL का उपयोग कर रहे हैं। यदि आपने हाल ही में अपनी कुंजी को पुनः जनरेट किया है, तो सुनिश्चित करें कि आपका क्लाइंट नई वैल्यू का उपयोग कर रहा है। एक 401 त्रुटि आपके उपयोग शेष या रेट लिमिट से संबंधित नहीं है; यह शुद्ध रूप से एक प्रमाणीकरण विफलता है।

रिज़ॉल्यूशन के लिए चेकलिस्ट

1. सुनिश्चित करें कि API कुंजी स्ट्रिंग डैशबोर्ड के साथ बिल्कुल मेल खाती है।
2. Authorization हेडर फॉर्मेट की जांच करें: Authorization: Bearer YOUR_KEY।
3. सुनिश्चित करें कि बेस URL आपके खाता प्रकार के लिए सही है।
4. सुनिश्चित करें कि कॉपी-पेस्ट के दौरान कोई अतिरिक्त स्पेस जोड़ा नहीं गया है।

रेट लिमिट अधिक: 429 त्रुटियाँ

जब आपकी अनुमत अनुरोध मात्रा से अधिक हो जाता है, तो API 429 Too Many Requests त्रुटि लौटाता है। हमारे सेवा के लिए, प्रति कुंजी प्रति मिनट 300 अनुरोधों के लिए सीमा निर्धारित की गई है। यह सीमा सभी उपयोगकर्ताओं के लिए निष्पक्ष उपयोग सुनिश्चित करने और कम लेटेंसी बनाए रखने के लिए लागू की जाती है। यदि आप उच्च-वॉल्यूम कोडिंग सत्र चला रहे हैं, तो आप इस सीमा को जल्दी पहुँच सकते हैं, खासकर यदि आपका कोड कई आंतरिक अनुरोध ट्रिगर करता है।

जब 429 त्रुटि होती है, तो प्रतिक्रिया में आमतौर पर एक Retry-After हेडर शामिल होता है जो बताता है कि पुनः प्रयास करने से पहले आपको कितने सेकंड प्रतीक्षा करनी चाहिए। अपने क्लाइंट कोड में एक्सपोनेंशियल बैकऑफ लागू करना इन त्रुटियों को प्रभावी ढंग से संभालने का मानक तरीका है। तुरंत पुनः प्रयास करने के बजाय, एक छोटा समय प्रतीक्षा करें, फिर अगले पुनः प्रयासों के लिए प्रतीक्षा समय को दोगुना करें। यह आपके एप्लिकेशन को सीमा रीसेट होने के दौरान सर्वर पर अनुरोधों की बाढ़ से बचाता है।

यह नोट करना महत्वपूर्ण है कि रेट लिमिट प्रति खाते नहीं, बल्कि प्रति कुंजी होते हैं। यदि आपके पास एक ही कुंजी का उपयोग करने वाले कई डिवाइस या प्रोसेस हैं, तो वे 300 अनुरोध/मिनट बजट साझा करते हैं। यदि आपको उच्च एग्रीगेट थ्रूपुट की आवश्यकता है, तो विभिन्न वातावरणों के लिए अलग-अलग कुंजियों का उपयोग करने पर विचार करें।

बेस URL को सही ढंग से कॉन्फ़िगर करना

बेस URL किसी भी API इंटीग्रेशन की नींव है। एक OpenAI-कम्पैटिबल सेवा के लिए, बेस URL निर्धारित करता है कि आपके अनुरोध कहाँ भेजे जाते हैं। हमारा बेस URL https://api.claudecodeapikey.com/v1 है। किसी भी अनुरोध करने से पहले इस URL को आपकी क्लाइंट लाइब्रेरी या SDK में कॉन्फ़िगर किया जाना चाहिए। यदि आप गलत बेस URL का उपयोग करते हैं, तो आपको कनेक्शन त्रुटियाँ या अप्रत्याशित प्रतिक्रियाएँ मिलेंगी।

अधिकतर डेवलपर आधिकारिक OpenAI SDK का उपयोग Python, Node.js, या अन्य भाषाओं के लिए करते हैं। हमारे प्रॉक्सी पर स्विच करने के लिए, आपको बेस यूआरएल कॉन्फ़िगरेशन को अपडेट करने की आवश्यकता है। उदाहरण के लिए, Python में, आप base_url='https://api.claudecodeapikey.com/v1' सेट कर सकते हैं। सुनिश्चित करें कि प्रोटोकॉल (https) और पथ (/v1) सही हैं। /v1 पथ छोड़ देना एक सामान्य गलती है जिससे 404 त्रुटियां होती हैं।

सदैव सत्यापित करें कि आपका क्लाइंट सही एंडपॉइंट पर अनुरोध भेज रहा है। आप यह अपने नेटवर्क लॉग जांचकर या कनेक्शन परीक्षण के लिए curl जैसे टूल का उपयोग करके कर सकते हैं। बेस यूआरएल पर सफल कनेक्शन पुष्टि करता है कि आपकी कॉन्फ़िगरेशन सही है।

स्ट्रीमिंग प्रतिक्रियाओं को हैंडल करना

स्ट्रीमिंग प्रतिक्रियाएँ आपको API प्रतिक्रिया के हिस्सों को प्राप्त करने की अनुमति देती हैं जैसे कि वे जनरेट हो रही हैं, पूरे प्रतिक्रिया को पूरा होने का प्रतीक्षा किए बिना। यह कोडिंग एजेंट्स के लिए महत्वपूर्ण है जो रियल-टाइम में कोड स्निपेट्स प्रदर्शित करते हैं। हमारी API सर्वर-सेंट इवेंट्स (SSE) के माध्यम से स्ट्रीमिंग का समर्थन करती है। जब आप अपने क्लाइंट में स्ट्रीमिंग सक्षम करते हैं, तो आपको एक चंक्स की स्ट्रीम प्राप्त होगी, प्रत्येक में एक आंशिक प्रतिक्रिया होती है।

स्ट्रीमिंग को सक्षम करने के लिए, अपने अनुरोध में stream पैरामीटर को true पर सेट करें। क्लाइंट लाइब्रेरी फिर स्वचालित रूप से SSE प्रोटोकॉल को संभाल लेगी। आप प्रत्येक चंक को आने पर प्रोसेस कर सकते हैं, अपनी UI को अपडेट करते हुए या प्रगति को लॉग करते हुए। यह एक बेहतर उपयोगकर्ता अनुभव प्रदान करता है, खासकर लंबे कोड जनरेशन के लिए।

स्ट्रीमिंग अंडरलाइंग मॉडल या इसकी क्षमताओं को नहीं बदलती है। यह शुद्ध रूप से एक ट्रांसपोर्ट मैकेनिज्म है। मॉडल अभी भी पूरी प्रॉम्प्ट को प्रोसेस करता है और पूर्ण प्रतिक्रिया जनरेट करता है; अंतर केवल इस बात में है कि आउटपुट आपके क्लाइंट तक कैसे पहुँचाया जाता है।

Copyfrom openai import OpenAI

client = OpenAI(base_url="https://api.claudecodeapikey.com/v1", api_key="YOUR_KEY")

resp = client.chat.completions.create(
    model="uncensored",
    messages=[{"role": "user", "content": "Summarise this thread without softening it."}],
)
print(resp.choices[0].message.content)

टूल कॉलिंग कॉन्फ़िगरेशन मुद्दे

टूल कॉलिंग (या फ़ंक्शन कॉलिंग) LLM को विशिष्ट एक्शन, जैसे कि कोड स्निपेट चलाना या डेटाबेस क्वेरी करना, का अनुरोध करने की अनुमति देती है। हमारी API टूल कॉलिंग का समर्थन करती है, जिसका मतलब है कि आप अपने अनुरोध में फ़ंक्शन परिभाषित कर सकते हैं और मॉडल से संरचित JSON प्रतिक्रियाएँ प्राप्त कर सकते हैं। यह उन्नत कोडिंग एजेंट्स के लिए आवश्यक है जिन्हें बाहरी सिस्टम के साथ इंटरैक्ट करने की आवश्यकता होती है।

टूल कॉलिंग कॉन्फ़िगर करने के लिए, आपको tools पैरामीटर में फ़ंक्शन परिभाषाओं की एक सूत्र प्रदान करनी होगी। प्रत्येक टूल में एक नाम, विवरण और पैरामीटर स्कीमा होना चाहिए। मॉडल फिर प्रॉम्प्ट के आधार पर तय करेगा कि कब टूल को कॉल करना है। यदि मॉडल टूल को कॉल करने का निर्णय लेता है, तो प्रतिक्रिया में tool_calls सर में फ़ंक्शन नाम और तर्क शामिल होंगे।

गलत JSON स्कीमा परिभाषाओं से सामान्य मुद्दे उत्पन्न होते हैं। सुनिश्चित करें कि आपके पैरामीटर टाइप्स और आवश्यक फ़ील्ड्स सटीक रूप से निर्दिष्ट हैं। यदि स्कीमा अमान्य है, तो मॉडल टूल को सही ढंग से कॉल करने में विफल हो सकता है। मॉडल की अपेक्षित व्यवस्था को समझने की पुष्टि करने के लिए अपने टूल परिभाषाओं को सरल प्रॉम्प्ट्स के साथ टेस्ट करें।

कॉन्टेक्स्ट विंडो सीमाएँ

कॉन्टेक्स्ट विंडो वह अधिकतम मात्रा में पाठ परिभाषित करता है जिसे मॉडल एकल अनुरोध में संसाधित कर सकता है, जिसमें प्रॉम्प्ट (इनपुट) और पूर्णता (आउटपुट) दोनों शामिल हैं। हमारे मॉडल की कॉन्टेक्स्ट विंडो 100,000 टोकन की है। यह पाठ की एक महत्वपूर्ण मात्रा है, लेकिन यह अनंत नहीं है। यदि आपका प्रॉम्प्ट plus अपेक्षित आउटपुट इस सीमा से अधिक हो जाता है, तो API एक त्रुटि लौटाएगा।

कॉन्टेक्स्ट को कुशलता से प्रबंधित करने के लिए, अपनी प्रॉम्प्ट के टोकन उपयोग की निगरानी करें। लंबे फ़ाइलें या व्यापक कन्वर्सेशन हिस्ट्री उपलब्ध टोकन को जल्दी खत्म कर सकती हैं। यदि आप सीमा के करीब पहुँचते हैं, तो पुराने संदेशों को ट्रंक करने या पिछली अंतर्क्रियाओं को सारांशित करने पर विचार करें। कुछ क्लाइंट स्वचालित रूप से इसे स्लाइडिंग विंडो के साथ हैंडल करते हैं, लेकिन अप्रत्याशित त्रुटियों से बचने के लिए सीमा के बारे में जागरूक रहना सर्वोत्तम है।

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

अपनी कुंजी को पुनः जनरेट करना

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

जब आप कुंजी को पुनः जनरेट करते हैं, तो सुनिश्चित करें कि आप अपने सभी क्लाइंट्स और कॉन्फ़िगरेशन को नए मान से अपडेट करें। इसमें एन्वायरमेंट वेरिएबल्स, कॉन्फ़िग फ़ाइलें और आपके कोड में किसी भी हार्डकोडेड मान शामिल हैं। सभी स्थानों को अपडेट न करने से आपके एप्लिकेशन के कुछ हिस्सों में प्रमाणीकरण त्रुटियां (authentication errors) आ सकती हैं।

हमारी सेवा असीमित कुंजी पुनर्जनन की अनुमति देती है। अपनी कुंजी को बार-बार रोटेट करने का कोई दंड नहीं है। यह साझित वातावरण में या टीम के सदस्यों को कुंजियाँ वितरित करते समय सुरक्षा बनाए रखने के लिए एक अच्छी प्रैक्टिस है।

Copycurl https://api.claudecodeapikey.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Write a blunt product review of a cheap VPN."}]
  }'