Developer guide
API कॉल करब
API संगत पथ आ स्ट्रीमिंग·आवाज नियम
ई पृष्ठ प्रमाणीकरण पूरा कएला बाद वास्तवमे कॉल करबाक पथक चर्चा करैत अछि।
OpenAI संगत पथ आ Anthropic संगत पथक सूची, अनुरोध निकायमे stream चालू कएलापर प्रतिक्रिया अबै के तरीका,
आ केवल आवाज·वॉइस पथपर लागू होएवाला नियमक क्रम एतय देल गेल अछि।
मॉडल ID आ मॉडल-विशिष्ट अनुमत कॉल मॉडल पृष्ठपर, आ प्रमाणीकरण हेडर आ base URL API की सँ प्रमाणीकरण करबाक पृष्ठपर अछि।
मार्ग चुनबाक प्रक्रिया
दुनू संगत विनिर्देश एक्के API कीक उपयोग करैत अछि, आ संवादात्मक तर्क मॉडलकेँ कोनो एक्के विनिर्देशक माध्यम सँ कॉल कएल जा सकैत अछि। अहाँक उद्देश्य आ उपयोगमे रहल SDK क अनुसार पथ चुनू।
| उद्देश्य | विनिर्देश | पथ |
|---|---|---|
| संवादात्मक तर्क, OpenAI SDK क उपयोग | OpenAI संगत | POST /chat/completions अथवा POST /responses |
| संवादात्मक तर्क, Anthropic SDK क उपयोग | Anthropic संगत | POST /v1/messages |
| एम्बेडिंग बनाबय | OpenAI संगत | POST /embeddings |
| आवाज संश्लेषण·लिप्यंतरण, वॉइस प्रबंधन | OpenAI संगत | /audio आ /voices क नीचाँक पथ |
| कॉल कएल जा सकनिहार मॉडल देखब | दुनू | GET /models |
OpenAI संगत पथ
base URL https://platform.clevi.net/api/v2/aiservice/openai/v1 अछि, आ अनुरोध आ प्रतिक्रियाक निकाय OpenAI विनिर्देशक पालन करैत अछि। नीचाँक सारणीमे तर्क आ मॉडल पथ देल अछि, जखन कि आवाज·वॉइस पथक विवरण आगाँक खंडमे अलगसँ देल गेल अछि।
| विधि | पथ | विवरण |
|---|---|---|
| POST | /api/v2/aiservice/openai/v1/chat/completions | वार्तालाप-आधारित तर्क। stream चालू केलासँ SSE द्वारा उत्तर देल जाइत अछि। |
| POST | /api/v2/aiservice/openai/v1/responses | Responses विनिर्देश कॉल। stream समर्थित अछि। |
| GET | /api/v2/aiservice/openai/v1/responses/{responseId} | संग्रहित उत्तरक एकटा अभिलेख देखू। |
| GET | /api/v2/aiservice/openai/v1/responses/{responseId}/input_items | संग्रहित उत्तरक इनपुट आइटम सभक सूची। |
| POST | /api/v2/aiservice/openai/v1/responses/{responseId}/cancel | पृष्ठभूमिमे चलि रहल उत्तर रद्द करू। |
| DELETE | /api/v2/aiservice/openai/v1/responses/{responseId} | संग्रहित उत्तर मेटाउ। |
| POST | /api/v2/aiservice/openai/v1/completions | लेगेसी पाठ पूर्णता। stream समर्थित अछि। |
| POST | /api/v2/aiservice/openai/v1/embeddings | एम्बेडिङ्ग बनाउ। स्ट्रीमिङ्ग समर्थित नहि अछि। |
| GET | /api/v2/aiservice/openai/v1/models | ई की सँ कॉल कऽ सकबाक मॉडल सभक सूची। |
| GET | /api/v2/aiservice/openai/v1/models/{modelId} | मॉडलक एकटा अभिलेख देखू। पहुँच नहि भए 404 होइत अछि। |
curl https://platform.clevi.net/api/v2/aiservice/openai/v1/chat/completions \
-H "X-API-Key: sk-..." \
-H "Content-Type: application/json" \
-d '{
"model": "cip-5.5-im",
"messages": [{"role": "user", "content": "안녕하세요"}]
}'sk-... केर स्थान पर API की स्क्रीन सँ जारी कएल की, आ model मे मॉडल पृष्ठक ID राखू।
अन्य पथ
| पथ | विवरण |
|---|---|
| GET /api/v2/aiservice/openai/v1/healthz | आवाज provider केर स्थिति जाँचैत अछि। |
| /api/v2/aiservice/openai/v1/api/status · /api/options · /api/generate · /outputs/{filename} | विरासत Cosa केर स्थिति·विकल्पक जानकारी, निर्माण कॉल(multipart), आ आउटपुट डाउनलोड करबाक लेल अछि। |
| /api/v2/aiservice/openai/v1/{routeKey} (GET · POST · PUT · PATCH · DELETE) | उपरि नहि देल provider पथसभकेँ नियम लागू कऽ रिले करैत अछि। POST रिले द्वारा chat/completions, completions, embeddings, responses बजओला पर 404 होइत अछि, ई चारूकेँ समर्पित पथ द्वारा संसाधित कएल जाइत अछि। |
Anthropic संगत पथ
base URL https://platform.clevi.net/api/v2/aiservice/anthropic अछि आ Anthropic SDK पथमे /v1 अपनेसँ जोड़ैत अछि। अनुरोध आ प्रतिक्रियाक मुख्य भाग Anthropic Messages विनिर्देशकेँ मानैत अछि।
| विधि | पथ | विवरण |
|---|---|---|
| POST | /api/v2/aiservice/anthropic/v1/messages | Messages विनिर्देश कॉल। model·messages·max_tokens आवश्यक अछि आ stream समर्थित अछि। |
| POST | /api/v2/aiservice/anthropic/v1/messages/count_tokens | बिना शुल्क केवल इनपुट टोकनक संख्या अनुमान करैत अछि। max_tokens आवश्यक नहि अछि। |
| GET | /api/v2/aiservice/anthropic/v1/models | कर्सर पृष्ठांकनयुक्त मॉडल सूची अछि। limit 1~1000 होइत अछि, सीमा सँ बाहर भेलापर 400 होइत अछि। |
| GET | /api/v2/aiservice/anthropic/v1/models/{modelId} | एकटा मॉडल केर जानकारी। पहुँच नहि भेला पर 404 होइत अछि। |
curl https://platform.clevi.net/api/v2/aiservice/anthropic/v1/messages \
-H "X-API-Key: sk-..." \
-H "anthropic-version: 2023-06-01" \
-H "Content-Type: application/json" \
-d '{
"model": "cip-5.5-im",
"max_tokens": 1024,
"messages": [{"role": "user", "content": "안녕하세요"}]
}'स्ट्रीमिंग (SSE)
अनुरोध बडीमे "stream": true राखलापर सर्वर Server-Sent Events केर माध्यमे प्रतिक्रिया दैत अछि। पथ आ मॉडल अनुसार ई नीचाँ देल गेल तरहेँ अलग-अलग अछि।
| लक्ष्य | क्रिया |
|---|---|
| OpenAI संगत POST /chat/completions · POST /completions · POST /responses | stream समर्थित अछि। |
| Anthropic संगत POST /v1/messages | stream समर्थित अछि। |
| POST /embeddings | स्ट्रीमिंग समर्थित नहि अछि। |
| Ivy खोज श्रेणीकेर मॉडल (ivy-4-mm-search आदि) | stream चालू कयलाक बादो सर्वर एकरा बन्द कऽ एके बेरमे प्रतिक्रिया दैत अछि। |
| GET /responses/{responseId}?stream=true | 400 सँ अस्वीकार कयल जाइत अछि। पृष्ठभूमि प्रतिक्रियाक उपयोगकेँ ठीक एक बेर मापल जा सकय, ताबत धरि ई पथ बन्द राखल गेल अछि। |
पहिल चंकक संग नीचाँ देल गेल तीनटा हेडर पठाओल जाइत अछि। तकर बाद प्रत्येक चंकमे event: पाँति (केवल अपस्ट्रीम द्वारा इवेंट नाम देल गेल हो तँ) आ data: पाँति पठाओल जाइत अछि आ तुरन्त flush कयल जाइत अछि।
- Content-Type: text/event-stream
- Cache-Control: no-cache
- X-Accel-Buffering: no
Anthropic संगत पथक चंकमे event पाँति आ data पाँति जोड़ीमे होइत अछि।
event: content_block_delta
data: {"type":"content_block_delta","index":0,"delta":{"type":"text_delta","text":"안"}}chat/completions केर चंक data पाँतिक रूपमे अबैत अछि, आ अन्तमे data: [DONE] जेकाँक तेकाँ पठाओल जाइत अछि।
data: {"id":"chatcmpl-...","object":"chat.completion.chunk","choices":[...]}
data: [DONE]ध्वनि आ भॉइस पथ
TTS·STT आ Cosa भॉइस प्रबन्धन पथ OpenAI संगत विनिर्देशमे अछि, आ सामान्य अनुमानसँ एकर किछु नियम भिन्न अछि। कोन मॉडल कोन पथकेँ अनुमति दैत अछि, से मॉडल पृष्ठक Cosa तालिकामे देल अछि।
| विधि | पथ | विवरण |
|---|---|---|
| POST | /api/v2/aiservice/openai/v1/audio/speech | पाठ केँ ध्वनि मे संश्लेषित कऽ ऑडियो जकाँक त्यँ डाउनलोड करैत अछि। |
| POST | /api/v2/aiservice/openai/v1/audio/transcriptions | ऑडियो केँ पाठ मे ट्रान्सक्राइब करैत अछि (multipart)। |
| POST | /api/v2/aiservice/openai/v1/audio/speech/clone | क्लोन कएल आवाज सँ ध्वनि संश्लेषित करैत अछि (multipart)। |
| GET | /api/v2/aiservice/openai/v1/voices | हमरा द्वारा उपयोग कएल जा सकनिहार आवाजक सूची। |
| POST | /api/v2/aiservice/openai/v1/voices | ऑडियो नमूना सँ आवाज पंजीकृत करैत अछि (multipart)। |
| POST | /api/v2/aiservice/openai/v1/voices/design | विवरण सँ संश्लेषित आवाज बनबैत अछि। |
| DELETE | /api/v2/aiservice/openai/v1/voices/{voiceId} | आवाज मेटबैत अछि। केवल मालिक ई कऽ सकैत छथि। |
| नियम | सामग्री |
|---|---|
| बाइनरी हस्तान्तरण | audio/speech, audio/speech/clone, outputs/{filename} कऽ सफल प्रतिक्रिया ऑडियोलाइ ज्योंकात्यों प्रवाहित करैत अछि आ एकहि समयमे CleviDrive मे सहेजैत अछि। |
| रसीद हेडर | X-Clevi-Drive-File-Id, X-Clevi-Drive-File-Version-Id, X-Clevi-Drive-Download-Url, X-Clevi-Drive-Expires-At, X-Clevi-Drive-Retention-Days: 3 पठाओल जाइत अछि। संरक्षण अवधि 3 दिन अछि आ तकर बाद 404 भेटैत अछि। |
| Product चयन | audio/speech आ audio/transcriptions मुख्य-पाठक model सँ Product चुनैत अछि। आवाज आ निदान पथ लेल X-Product-Sku हेडर अथवा product_sku क्वेरी आवश्यक अछि। |
| आवाजक स्वामित्व | क्लोन वा पंजीकृत आवाज ओकरा बनौनिहारक स्वामित्वमे रहैत अछि। दोसर व्यक्तिक आवाजसँ संश्लेषण करबाक अथवा मेटाबयबाक प्रयास करला पर 403 भेटैत अछि, आ GET /voices सूचीमे सेहो केवल अपन स्वामित्वक आवाज रहैत अछि। |
| आकार आ समय | अनुरोध सीमा 28 MiB अछि, आ अपस्ट्रीम कॉलक समय सीमा 5 मिनट अछि। |
| provider भीड़ | अपस्ट्रीम व्यस्त रहला पर 409 ज्योंकात्यों अग्रेषित कएल जाइत अछि, आ Retry-After देल गेल हो तऽ ओ मान सेहो संगहि अग्रेषित कएल जाइत अछि। गेटवे पुनः प्रयास नहि करैत अछि आ कतारमे नहि राखैत अछि। |
