OrkasOrkas
डाउनलोड GitHub
Orkas API

Orkas API दस्तावेज़

Orkas की चैट, खोज, वाणी, चित्र और वीडियो क्षमताओं को अपने टूल से जोड़ें। अधिकांश AI ऐप्लिकेशन में इस्तेमाल होने वाला बेस URL, API कुंजी और मॉडल नाम जानने के लिए चैट से शुरुआत करें।

चैट

Chat और Responses मॉडल के उत्तर और कस्टम फ़ंक्शन कॉल देते हैं, जिन्हें आपका ऐप्लिकेशन संभालता है; इमेज और वीडियो एंडपॉइंट मीडिया बनाते हैं। ये API कॉल डेस्कटॉप Commander का टास्क शुरू नहीं करते और न ही उसके एजेंट अपने-आप शामिल होते हैं। एजेंट का कोई अतिरिक्त समन्वय आपके ऐप्लिकेशन के वर्कफ़्लो पर निर्भर करता है।

कनेक्शन सेटिंग

यदि कोई ऐप्लिकेशन बेस 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 शामिल हैं।

Responses अनुशंसित

एंडपॉइंट

POST
https://orkas.ai/v1/responses
Responses

प्रमाणीकरण

Authorization: Bearer $ORKAS_API_KEY

अनुरोध बॉडी के पैरामीटर

पैरामीटरप्रकारआवश्यकविवरण
modelstringहाँorkas-llm-1.5 या orkas-llm-1.5-pro।
inputstring / arrayहाँटेक्स्ट या बातचीत के आइटम।
reasoningobjectनहींवैकल्पिक तर्क स्तर: low, medium या high।
toolsarrayनहींआपके ऐप द्वारा चलाए जाने वाले टूल के फ़ंक्शन की परिभाषाएँ।
streambooleanनहींtrue होने पर स्ट्रीमिंग प्रतिक्रिया लौटाएँ। डिफ़ॉल्ट: false।

अनुरोध का उदाहरण

curl https://orkas.ai/v1/responses \
  -H "Authorization: Bearer $ORKAS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "orkas-llm-1.5",
    "input": "Hello",
    "reasoning": {"effort": "medium"}
  }'

Chat

एंडपॉइंट

POST
https://orkas.ai/v1/chat/completions
Chat

प्रमाणीकरण

Authorization: Bearer $ORKAS_API_KEY

अनुरोध बॉडी के पैरामीटर

पैरामीटरप्रकारआवश्यकविवरण
modelstringहाँorkas-llm-1.5 या orkas-llm-1.5-pro।
messagesarrayहाँबातचीत के संदेश। हर आइटम में role और content होते हैं।
streambooleanनहीं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इनपुट 50–100; कैश पढ़ना 5–10; कैश बनाना 62.5–125; आउटपुट 250–375मुख्य मॉडल के प्रति 10 लाख टोकन की दर।
orkas-llm-1.5-proइनपुट 200–400; कैश पढ़ना 10–20; कैश बनाना 250–500; आउटपुट 1,000–1,500मुख्य मॉडल के प्रति 10 लाख टोकन की दर।

वाणी

टेक्स्ट को ऑडियो फ़ाइल में बदलें। नीचे की सूची से वॉइस ID और अपना आवश्यक ऑडियो प्रारूप चुनें।

आवाज़ों की सूची देखें

एंडपॉइंट

GET
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_bigttsvivi 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_bigttsTimअंग्रेज़ी
en_female_dacey_uranus_bigttsDaceyअंग्रेज़ी
en_female_stokie_uranus_bigttsStokieअंग्रेज़ी

वाणी बनाएँ

एंडपॉइंट

POST
https://orkas.ai/v1/audio/speech
वाणी बनाएँ

प्रमाणीकरण

Authorization: Bearer $ORKAS_API_KEY

अनुरोध बॉडी के पैरामीटर

पैरामीटरप्रकारआवश्यकविवरण
modelstringहाँorkas-tts-1 इस्तेमाल करें।
inputstringहाँवाणी में बदलने वाला टेक्स्ट, अधिकतम 16,384 UTF-8 बाइट।
voicestringहाँऊपर की सूची से वॉइस ID।
languagestringनहींवर्णन की भाषा, जैसे zh-CN या en। चुनी गई आवाज़ में इसका समर्थन होना चाहिए; अन्यथा आवाज़ की डिफ़ॉल्ट भाषा इस्तेमाल होती है।
response_formatstringनहींmp3, wav, opus या ogg। डिफ़ॉल्ट: mp3।
speednumberनहींवाणी की गति 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प्रति अनुमानित आउटपुट सेकंड, ऊपर की ओर पूर्णांकित करके कम से कम एक सेकंड।

चित्र

विवरण से चित्र बनाएँ, या संपादन के लिए संदर्भ चित्र दें। हर अनुरोध पर एक चित्र लौटाया जाता है।

चित्र बनाएँ

एंडपॉइंट

POST
https://orkas.ai/v1/images/generations
चित्र बनाएँ

प्रमाणीकरण

Authorization: Bearer $ORKAS_API_KEY

अनुरोध बॉडी के पैरामीटर

पैरामीटरप्रकारआवश्यकविवरण
promptstringहाँचित्र का विवरण, अधिकतम 20,000 वर्ण।
sizestringनहीं1k / 1.5k / 2k या समर्थित चौड़ाई×ऊँचाई मान। डिफ़ॉल्ट: 1.5k।
response_formatstringनहींurl या b64_json। डिफ़ॉल्ट: b64_json।
reference_imagesarrayनहींसंपादन के लिए अधिकतम चार HTTPS URL या समर्थित चित्र डेटा URL।
asyncbooleanनहीं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":"1.5k",
    "response_format":"url",
    "async":true
  }'
अधिक समय लेने वाले अनुरोधों के लिए: "async": true सेट करें। API कार्य का id लौटाता है; परिणाम तैयार होने तक स्थिति URL इस्तेमाल करें।

निर्माण की स्थिति जाँचें

एंडपॉइंट

GET
https://orkas.ai/v1/images/generations/{id}
निर्माण की स्थिति जाँचें

प्रमाणीकरण

Authorization: Bearer $ORKAS_API_KEY

पाथ पैरामीटर

पैरामीटरप्रकारआवश्यकविवरण
idstringहाँबनाने के अनुरोध से लौटाया गया कार्य ID।

अनुरोध का उदाहरण

curl https://orkas.ai/v1/images/generations/$TASK_ID \
  -H "Authorization: Bearer $ORKAS_API_KEY"

क्रेडिट उपयोग

बिलिंग मदक्रेडिट कटौतीबिलिंग इकाई
चित्र बनाएँ13–23 क्रेडिट / आउटपुट चित्र + 5 / इनपुट चित्र13–23 क्रेडिट / आउटपुट चित्र + 5 / इनपुट चित्र (≤2.61 MP: 13; >2.61 MP: 23)
निर्माण की स्थिति जाँचें0प्रति अनुरोध

वीडियो

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

वीडियो बनाएँ

एंडपॉइंट

POST
https://orkas.ai/v1/videos
वीडियो बनाएँ

प्रमाणीकरण

Authorization: Bearer $ORKAS_API_KEY

अनुरोध बॉडी के पैरामीटर

पैरामीटरप्रकारआवश्यकविवरण
promptstringहाँबनाए या संपादित किए जाने वाले वीडियो का विवरण।
durationintegerनहीं4–15 सेकंड। डिफ़ॉल्ट: 5।
resolutionstringनहीं480p, 720p या 1080p। डिफ़ॉल्ट: 720p।
qualitystringनहींbalanced गति और क्रेडिट उपयोग में संतुलन रखता है; quality निर्माण की गुणवत्ता और स्थिरता को प्राथमिकता देता है। डिफ़ॉल्ट: balanced। Orkas फिर भी संगत वीडियो मॉडल अपने आप चुनता है।
ratiostringनहीं16:9, 9:16, 1:1, 4:3, 3:4 या 21:9। डिफ़ॉल्ट: 16:9।
generate_audiobooleanनहींवीडियो का ऑडियो बनाएँ। डिफ़ॉल्ट: true।
reference_image_urlsarrayनहींअधिकतम नौ सार्वजनिक HTTPS चित्र URL।
reference_video_urlsarrayनहींअधिकतम तीन सार्वजनिक HTTPS वीडियो URL।
operationstringनहींgenerate या edit। संपादन के लिए कम से कम एक संदर्भ वीडियो आवश्यक है। डिफ़ॉल्ट: generate।
seedintegerनहींदोहराने योग्य निर्माण के लिए वैकल्पिक सीड।

अनुरोध का उदाहरण

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
  }'

वीडियो की स्थिति जाँचें

एंडपॉइंट

GET
https://orkas.ai/v1/videos/{id}
वीडियो की स्थिति जाँचें

प्रमाणीकरण

Authorization: Bearer $ORKAS_API_KEY

पाथ पैरामीटर

पैरामीटरप्रकारआवश्यकविवरण
idstringहाँबनाने के अनुरोध से लौटाया गया कार्य ID।

अनुरोध का उदाहरण

curl https://orkas.ai/v1/videos/$TASK_ID \
  -H "Authorization: Bearer $ORKAS_API_KEY"

क्रेडिट उपयोग

बिलिंग मदक्रेडिट कटौतीबिलिंग इकाई
balanced · टेक्स्ट या चित्र से वीडियो · 480p37प्रति आउटपुट सेकंड
balanced · टेक्स्ट या चित्र से वीडियो · 720p80प्रति आउटपुट सेकंड
balanced · टेक्स्ट या चित्र से वीडियो · 1080p248प्रति आउटपुट सेकंड
quality · टेक्स्ट या चित्र से वीडियो · 480p46प्रति आउटपुट सेकंड
quality · टेक्स्ट या चित्र से वीडियो · 720p100प्रति आउटपुट सेकंड
quality · टेक्स्ट या चित्र से वीडियो · 1080p248प्रति आउटपुट सेकंड
balanced / quality · वीडियो संपादन या संदर्भ वीडियो से निर्माण · 480p28001M tokens
संदर्भ वीडियो: बिल किए गए वास्तविक टोकन में इनपुट/आउटपुट वीडियो और न्यूनतम उपयोग शामिल हैं; संदर्भ चित्रों का अलग शुल्क नहीं
balanced / quality · वीडियो संपादन या संदर्भ वीडियो से निर्माण · 720p28001M tokens
संदर्भ वीडियो: बिल किए गए वास्तविक टोकन में इनपुट/आउटपुट वीडियो और न्यूनतम उपयोग शामिल हैं; संदर्भ चित्रों का अलग शुल्क नहीं
balanced / quality · वीडियो संपादन या संदर्भ वीडियो से निर्माण · 1080p31001M tokens
संदर्भ वीडियो: बिल किए गए वास्तविक टोकन में इनपुट/आउटपुट वीडियो और न्यूनतम उपयोग शामिल हैं; संदर्भ चित्रों का अलग शुल्क नहीं
वीडियो की स्थिति जाँचें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 के भीतर हुए उपयोग से अलग पहचान सकें।