Orkas API दस्तावेज़
Orkas की चैट, खोज, वाणी, चित्र और वीडियो क्षमताओं को अपने टूल से जोड़ें। अधिकांश AI ऐप्लिकेशन में इस्तेमाल होने वाला बेस URL, API कुंजी और मॉडल नाम जानने के लिए चैट से शुरुआत करें।
चैट
AI ऐप्लिकेशन, कमांड-लाइन टूल या अपनी सेवा में OpenAI-संगत Chat Completions प्रारूप इस्तेमाल करें।
कनेक्शन सेटिंग
यदि कोई ऐप्लिकेशन बेस URL, API कुंजी और मॉडल माँगे, तो निम्न मान दर्ज करें।
| सेटिंग | मान | विवरण |
|---|---|---|
Base URL | https://orkas.ai/v1 | इसे OpenAI-संगत सेवा पते के रूप में इस्तेमाल करें। |
API Key | खाते में कुंजी बनाएँ | कुंजी को ऐप्लिकेशन के API कुंजी फ़ील्ड में पेस्ट करें। |
model | orkas-llm-1.5अनुशंसित | रोज़मर्रा के प्रश्नोत्तर, लेखन और कार्यालय के काम के लिए सबसे उपयुक्त। इसमें DeepSeek V4.1 Flash · GPT-6 Luna · Claude-Sonnet-5 · Gemini-3.8 Flash शामिल हैं। |
orkas-llm-1.5-pro | शोध, वीडियो, अनुसंधान व विकास और अन्य जटिल कार्यों के लिए सबसे उपयुक्त। इसमें GPT-6 Sol · Claude Opus 5.5 · Kimi K3 शामिल हैं। |
चैट कम्प्लीशन बनाएँ
एंडपॉइंट
https://orkas.ai/v1/chat/completionsप्रमाणीकरण
Authorization: Bearer $ORKAS_API_KEYअनुरोध बॉडी के पैरामीटर
| पैरामीटर | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
model | string | हाँ | orkas-llm-1.5 या orkas-llm-1.5-pro। |
messages | array | हाँ | बातचीत के संदेश। हर आइटम में role और content होते हैं। |
stream | boolean | नहीं | true होने पर स्ट्रीमिंग प्रतिक्रिया लौटाएँ। डिफ़ॉल्ट: false। |
अनुरोध का उदाहरण
curl https://orkas.ai/v1/chat/completions \
-H "Authorization: Bearer $ORKAS_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "orkas-llm-1.5",
"messages": [{"role": "user", "content": "Hello"}]
}'क्रेडिट उपयोग
| बिलिंग मद | क्रेडिट कटौती | बिलिंग इकाई |
|---|---|---|
orkas-llm-1.5 | इनपुट 20–280; कैश पढ़ना 2–28; कैश बनाना 25–350; आउटपुट 120–1,260 | प्रति 1M टोकन; सटीक दर अनुरोध पर निर्भर करती है। |
orkas-llm-1.5-pro | इनपुट 140–1,000; कैश पढ़ना 14–100; कैश बनाना 175–1,250; आउटपुट 840–4,500 | प्रति 1M टोकन; सटीक दर अनुरोध पर निर्भर करती है। |
खोजें
वेब पर खोजें और अपने ऐप्लिकेशन के लिए प्रासंगिक परिणामों की संक्षिप्त सूची पाएँ।
वेब पर खोजें
एंडपॉइंट
https://orkas.ai/v1/searchप्रमाणीकरण
Authorization: Bearer $ORKAS_API_KEYअनुरोध बॉडी के पैरामीटर
| पैरामीटर | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
query | string | हाँ | खोज का टेक्स्ट, अधिकतम 2,000 वर्ण। |
max_results | integer | नहीं | परिणामों की संख्या, 1–20। डिफ़ॉल्ट: 8। |
अनुरोध का उदाहरण
curl https://orkas.ai/v1/search \
-H "Authorization: Bearer $ORKAS_API_KEY" \
-H "Content-Type: application/json" \
-d '{"query":"latest battery research","max_results":8}'क्रेडिट उपयोग
| बिलिंग मद | क्रेडिट कटौती | बिलिंग इकाई |
|---|---|---|
| वेब पर खोजें | 5.6 | प्रति अनुरोध, अधिकतम 20 परिणामों के लिए। |
वाणी
टेक्स्ट को ऑडियो फ़ाइल में बदलें। नीचे की सूची से वॉइस ID और अपना आवश्यक ऑडियो प्रारूप चुनें।
आवाज़ों की सूची देखें
एंडपॉइंट
https://orkas.ai/v1/audio/voicesप्रमाणीकरण
Authorization: Bearer $ORKAS_API_KEYअनुरोध पैरामीटर
इस एंडपॉइंट में कोई अनुरोध पैरामीटर नहीं है।
अनुरोध का उदाहरण
curl https://orkas.ai/v1/audio/voices \
-H "Authorization: Bearer $ORKAS_API_KEY"उपलब्ध वॉइस ID
| वॉइस ID | नाम | भाषा |
|---|---|---|
zh_female_vv_uranus_bigtts | vivi 2.0 | चीनी / अंग्रेज़ी |
saturn_zh_female_cancan_tob | 知性灿灿 | चीनी |
saturn_zh_female_keainvsheng_tob | 可爱女生 | चीनी |
saturn_zh_female_tiaopigongzhu_tob | 调皮公主 | चीनी |
saturn_zh_male_shuanglangshaonian_tob | 爽朗少年 | चीनी |
saturn_zh_male_tiancaitongzhuo_tob | 天才同桌 | चीनी |
zh_female_xiaohe_uranus_bigtts | 小何 | चीनी |
zh_male_m191_uranus_bigtts | 云舟 | चीनी |
zh_male_taocheng_uranus_bigtts | 小天 | चीनी |
en_male_tim_uranus_bigtts | Tim | अंग्रेज़ी |
en_female_dacey_uranus_bigtts | Dacey | अंग्रेज़ी |
en_female_stokie_uranus_bigtts | Stokie | अंग्रेज़ी |
वाणी बनाएँ
एंडपॉइंट
https://orkas.ai/v1/audio/speechप्रमाणीकरण
Authorization: Bearer $ORKAS_API_KEYअनुरोध बॉडी के पैरामीटर
| पैरामीटर | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
model | string | हाँ | orkas-tts-1 इस्तेमाल करें। |
input | string | हाँ | वाणी में बदलने वाला टेक्स्ट, अधिकतम 16,384 UTF-8 बाइट। |
voice | string | हाँ | ऊपर की सूची से वॉइस ID। |
language | string | नहीं | वर्णन की भाषा, जैसे zh-CN या en। चुनी गई आवाज़ में इसका समर्थन होना चाहिए; अन्यथा आवाज़ की डिफ़ॉल्ट भाषा इस्तेमाल होती है। |
response_format | string | नहीं | mp3, wav, opus या ogg। डिफ़ॉल्ट: mp3। |
speed | number | नहीं | वाणी की गति 0.5 से 2.0 तक। डिफ़ॉल्ट: 1.0। |
अनुरोध का उदाहरण
curl https://orkas.ai/v1/audio/speech \
-H "Authorization: Bearer $ORKAS_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"model":"orkas-tts-1",
"input":"你好,欢迎使用 Orkas。",
"voice":"zh_female_vv_uranus_bigtts",
"language":"zh-CN",
"response_format":"mp3",
"speed":1.0
}' --output speech.mp3क्रेडिट उपयोग
| बिलिंग मद | क्रेडिट कटौती | बिलिंग इकाई |
|---|---|---|
| आवाज़ों की सूची देखें | 0 | प्रति अनुरोध |
| वाणी बनाएँ | 0.125 | प्रति अनुमानित आउटपुट सेकंड, ऊपर की ओर पूर्णांकित करके कम से कम एक सेकंड। |
चित्र
विवरण से चित्र बनाएँ, या संपादन के लिए संदर्भ चित्र दें। हर अनुरोध पर एक चित्र लौटाया जाता है।
चित्र बनाएँ
एंडपॉइंट
https://orkas.ai/v1/images/generationsप्रमाणीकरण
Authorization: Bearer $ORKAS_API_KEYअनुरोध बॉडी के पैरामीटर
| पैरामीटर | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
prompt | string | हाँ | चित्र का विवरण, अधिकतम 20,000 वर्ण। |
size | string | नहीं | 2k, 3k, 4k या समर्थित चौड़ाई×ऊँचाई मान। डिफ़ॉल्ट: 2k। |
response_format | string | नहीं | url या b64_json। डिफ़ॉल्ट: b64_json। |
reference_images | array | नहीं | संपादन के लिए अधिकतम चार HTTPS URL या समर्थित चित्र डेटा URL। |
async | boolean | नहीं | true होने पर कार्य ID लौटाएँ। अनुरोध का समय समाप्त होने से बचने के लिए अनुशंसित। डिफ़ॉल्ट: false। |
अनुरोध का उदाहरण
curl https://orkas.ai/v1/images/generations \
-H "Authorization: Bearer $ORKAS_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"prompt":"A product photo on a clean studio background",
"size":"2k",
"response_format":"url",
"async":true
}'"async": true सेट करें। API कार्य का id लौटाता है; परिणाम तैयार होने तक स्थिति URL इस्तेमाल करें।निर्माण की स्थिति जाँचें
एंडपॉइंट
https://orkas.ai/v1/images/generations/{id}प्रमाणीकरण
Authorization: Bearer $ORKAS_API_KEYपाथ पैरामीटर
| पैरामीटर | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
id | string | हाँ | बनाने के अनुरोध से लौटाया गया कार्य ID। |
अनुरोध का उदाहरण
curl https://orkas.ai/v1/images/generations/$TASK_ID \
-H "Authorization: Bearer $ORKAS_API_KEY"क्रेडिट उपयोग
| बिलिंग मद | क्रेडिट कटौती | बिलिंग इकाई |
|---|---|---|
| चित्र बनाएँ | 22 | प्रति निर्मित चित्र |
| निर्माण की स्थिति जाँचें | 0 | प्रति अनुरोध |
वीडियो
टेक्स्ट या संदर्भ मीडिया से वीडियो बनाएँ। वीडियो अनुरोध असमकालिक रूप से चलते हैं, इसलिए प्रगति जाँचने के लिए लौटाया गया कार्य ID इस्तेमाल करें।
वीडियो बनाएँ
एंडपॉइंट
https://orkas.ai/v1/videosप्रमाणीकरण
Authorization: Bearer $ORKAS_API_KEYअनुरोध बॉडी के पैरामीटर
| पैरामीटर | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
prompt | string | हाँ | बनाए या संपादित किए जाने वाले वीडियो का विवरण। |
duration | integer | नहीं | 4–15 सेकंड। डिफ़ॉल्ट: 5। |
resolution | string | नहीं | 480p, 720p या 1080p। डिफ़ॉल्ट: 720p। |
quality | string | नहीं | balanced गति और क्रेडिट उपयोग में संतुलन रखता है; quality निर्माण की गुणवत्ता और स्थिरता को प्राथमिकता देता है। डिफ़ॉल्ट: balanced। Orkas फिर भी संगत वीडियो मॉडल अपने आप चुनता है। |
ratio | string | नहीं | 16:9, 9:16, 1:1, 4:3, 3:4 या 21:9। डिफ़ॉल्ट: 16:9। |
generate_audio | boolean | नहीं | वीडियो का ऑडियो बनाएँ। डिफ़ॉल्ट: true। |
reference_image_urls | array | नहीं | अधिकतम नौ सार्वजनिक HTTPS चित्र URL। |
reference_video_urls | array | नहीं | अधिकतम तीन सार्वजनिक HTTPS वीडियो URL। |
operation | string | नहीं | generate या edit। संपादन के लिए कम से कम एक संदर्भ वीडियो आवश्यक है। डिफ़ॉल्ट: generate। |
seed | integer | नहीं | दोहराने योग्य निर्माण के लिए वैकल्पिक सीड। |
अनुरोध का उदाहरण
curl https://orkas.ai/v1/videos \
-H "Authorization: Bearer $ORKAS_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"prompt":"Camera circles a ceramic lamp in a dark studio",
"duration":5,
"resolution":"720p",
"quality":"balanced",
"ratio":"16:9",
"generate_audio":true
}'वीडियो की स्थिति जाँचें
एंडपॉइंट
https://orkas.ai/v1/videos/{id}प्रमाणीकरण
Authorization: Bearer $ORKAS_API_KEYपाथ पैरामीटर
| पैरामीटर | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
id | string | हाँ | बनाने के अनुरोध से लौटाया गया कार्य ID। |
अनुरोध का उदाहरण
curl https://orkas.ai/v1/videos/$TASK_ID \
-H "Authorization: Bearer $ORKAS_API_KEY"क्रेडिट उपयोग
| बिलिंग मद | क्रेडिट कटौती | बिलिंग इकाई |
|---|---|---|
balanced · टेक्स्ट या चित्र से वीडियो · 480p | 37 | प्रति आउटपुट सेकंड |
balanced · टेक्स्ट या चित्र से वीडियो · 720p | 80 | प्रति आउटपुट सेकंड |
balanced · टेक्स्ट या चित्र से वीडियो · 1080p | 248 | प्रति आउटपुट सेकंड |
quality · टेक्स्ट या चित्र से वीडियो · 480p | 46 | प्रति आउटपुट सेकंड |
quality · टेक्स्ट या चित्र से वीडियो · 720p | 100 | प्रति आउटपुट सेकंड |
quality · टेक्स्ट या चित्र से वीडियो · 1080p | 248 | प्रति आउटपुट सेकंड |
balanced / quality · वीडियो संपादन या संदर्भ वीडियो से निर्माण · 480p | 51 | प्रति आउटपुट सेकंड |
balanced / quality · वीडियो संपादन या संदर्भ वीडियो से निर्माण · 720p | 109 | प्रति आउटपुट सेकंड |
balanced / quality · वीडियो संपादन या संदर्भ वीडियो से निर्माण · 1080p | 271 | प्रति आउटपुट सेकंड |
| वीडियो की स्थिति जाँचें | 0 | प्रति अनुरोध |
सुरक्षा और सीमाएँ
API कुंजियाँ निजी रखें, अलग-अलग ऐप्लिकेशन के लिए अलग कुंजियाँ इस्तेमाल करें और कुंजी लीक होने की आशंका हो तो उसे तुरंत हटा दें।
Authorization: Bearer sk-orkas-…अनुरोध हेडर में कुंजी भेजें।- एक बातचीत के क्रेडिट उपयोग को समूहित करने के लिए उसके अनुरोधों में
X-Orkas-Conversation-Idके अंतर्गत एक ही अपारदर्शी ID भेजें। केवल अक्षर, अंक,-या_इस्तेमाल करें (अधिकतम 64 वर्ण); शीर्षक या संदेश की सामग्री न भेजें। - कुंजी को ब्राउज़र या मोबाइल ऐप के कोड, URL, लॉग या स्रोत नियंत्रण में न रखें।
- हर ऐप्लिकेशन के लिए अलग कुंजी बनाएँ ताकि दूसरी सेवाओं को प्रभावित किए बिना उसे बदला जा सके।
- प्रति-कुंजी सीमाएँ: चैट और खोज के लिए 120 अनुरोध/मिनट, वाणी के लिए 60, चित्र के लिए 30 अनुरोध और वीडियो के लिए 10 अनुरोध। स्थिति जाँच के लिए 120 अनुरोध/मिनट की अनुमति है।
- अनुरोध बहुत अधिक बार होने पर API HTTP 429 लौटाता है। फिर कोशिश करने से पहले थोड़ी देर प्रतीक्षा करें।
क्रेडिट इतिहास
Orkas Web के क्रेडिट इतिहास में API उपयोग अलग से चिह्नित होता है, ताकि आप उसे Orkas के भीतर हुए उपयोग से अलग पहचान सकें।