Developer guide
API कुंजी सँ प्रमाणित होनाइ
API कुंजी रखबाक हेडर आ SDK मे सेट करबाक base URL
ई पृष्ठ CLEVI गेटवे मे API कुंजी सँ प्रमाणित करबाक तरीका बतबैत अछि।
OpenAI संगत मार्ग आ Anthropic संगत मार्ग दुनू मे एक्के कुंजी सँ प्रमाणित होइत अछि,
मुदा कुंजी रखबाक हेडरक स्वीकार्य सीमा आ SDK मे सेट करबाक base URL प्रत्येक विनिर्देश अनुसार अलग अछि।
प्रमाणीकरण हेडर
दुनू संगत विनिर्देश मे एक्के API कुंजी सँ प्रमाणित होइत अछि। कुंजी कंसोलक API कुंजी स्क्रीन सँ जारी कएल जाइत अछि, आ ओही स्क्रीन पर रद्दीकरण आ उपयोगक दायरा प्रबंधित कएल जाइत अछि।
| हेडर | OpenAI संगत | Anthropic संगत |
|---|---|---|
| X-API-Key: <키> | उपलब्ध | उपलब्ध |
| Authorization: Bearer <키> | उपलब्ध | उपलब्ध |
| Authorization: <키> (Bearer बिना) | अस्वीकृत | उपलब्ध |
हेडरक नाम मे बड़का-छोटका अक्षरक भेद नहि कएल जाइत अछि। Anthropic SDK द्वारा भेजल x-api-key सेहो जकाँक तैँ काज करैत अछि।
base URL
पहिने सँ उपयोग करैत SDK मे base URL केँ नीचाँ देल गेल पता सँ बदललापर ओनाेहि उपयोग कएल जा सकैत अछि। दुनू पता मे /v1 शामिल अछि वा नहि, एहि मे अंतर अछि।
| विनिर्देश | base URL | मार्ग नियम |
|---|---|---|
| OpenAI संगत | https://platform.clevi.net/api/v2/aiservice/openai/v1 | /v1 धरि base URL मे शामिल करैत अछि। |
| Anthropic संगत | https://platform.clevi.net/api/v2/aiservice/anthropic | Anthropic SDK मार्ग मे /v1 अपने सँ जोड़ैत अछि, तेँ ई /v1 सँ पहिने समाप्त होइत अछि। |
प्रमाणीकरण जाँच
कुंजी आ base URL दऽ मॉडल सूची पूछला पर तुरन्त बुझि सकैत छी जे प्रमाणीकरण भेल अछि वा नहि। नीचाँक तीनू एक्के पूछताछ curl, OpenAI SDK आ Anthropic SDK सँ करैत अछि।
curl https://platform.clevi.net/api/v2/aiservice/openai/v1/models \
-H "X-API-Key: sk-..."
curl https://platform.clevi.net/api/v2/aiservice/anthropic/v1/models \
-H "Authorization: Bearer sk-..." \
-H "anthropic-version: 2023-06-01"from openai import OpenAI
client = OpenAI(
api_key="sk-...",
base_url="https://platform.clevi.net/api/v2/aiservice/openai/v1",
)
for model in client.models.list():
print(model.id)from anthropic import Anthropic
client = Anthropic(
api_key="sk-...",
base_url="https://platform.clevi.net/api/v2/aiservice/anthropic",
)
for model in client.models.list(limit=20).data:
print(model.id)sk-... स्थान पर API कुंजी स्क्रीन सँ जारी कएल गेल कुंजी राखू।
- प्रतिक्रिया 200 भेला पर प्रमाणीकरण भेल अछि। data मे एहि कुंजी सँ कॉल कऽ सकनिहार मॉडल सभक सूची रहैत अछि।
- प्रतिक्रिया 401 भेला पर नीचाँक प्रमाणीकरण विफलता खंडक क्रम सँ जाँच करू।
संग उपयोग करबाक हेडर
हे सर्व पर्यायी आहेत. समस्या शोधण्यासाठी X-Request-Id समाविष्ट करणे चांगले आहे.
| हेडर | उपयोग | वगळल्यास |
|---|---|---|
| X-Request-Id | विनंतीचा मागोवा घेण्यासाठी ओळखकर्ता. Anthropic-सुसंगत प्रतिसादात तो request-id हेडर म्हणून परत येतो. | सर्व्हर जारी करतो. |
| X-Region-Code | कॉलचा प्रदेश | global आहे. |
| X-Product-Sku (क्वेरी product_sku द्वारेही शक्य) | बिलिंगसाठी वापरायचा Product SKU थेट निर्दिष्ट करतो. हेडरला क्वेरीपेक्षा प्राधान्य आहे आणि तो प्रामुख्याने व्हॉइस मार्गांमध्ये वापरला जातो. | व्हॉइस मार्गांमध्ये आवश्यक आहे. audio/speech आणि audio/transcriptions मध्ये मजकुरातील model द्वारे Product निवडले जाते. |
| anthropic-version / anthropic-beta | Anthropic-सुसंगत मार्गावर जसेच्या तसे पुढे पाठवले जाते. | आवृत्ती 2023-06-01 आहे. |
प्रमाणीकरण अयशस्वी
की नसल्यास किंवा कालबाह्य·रद्द केलेली की पाठवल्यास 401 मिळतो. OpenAI-सुसंगत मार्गावर कीशिवाय कॉल केल्यास खालील मजकूर मिळतो, तर Anthropic-सुसंगत मार्गातील error.type हे authentication_error असते.
{
"error": {
"message": "API key is required.",
"type": "invalid_request_error"
}
}- API कीच्या पृष्ठावर कीची स्थिती तपासा. ती कालबाह्य·रद्द केलेली असल्यास नवीन की जारी करा.
- हेडरचे नाव X-API-Key किंवा Authorization आहे का ते तपासा.
- OpenAI-सुसंगत मार्गावर Authorization वापरत असल्यास Bearer उपसर्ग तपासा.