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 उपसर्ग जाँच गर्नुहोस्।
