सारांश

Endpoints

हर endpoint एक बेस URL के नीचे है और HTTPS पर परोसा जाता है।

https://api.shannon-ai.com

टेक्स्ट बनाने वाले तीनों endpoints एक ही मॉडल तक पहुँचते हैं। वह चुनें जिसका फ़ॉर्मेट आपका कोड पहले से इस्तेमाल करता है।

अनुरोध की मूल बातें

• हर POST की बॉडी एक JSON ऑब्जेक्ट होती है, अधिकतम 32 MiB।
• जो फ़ील्ड API नहीं जानती, उससे कोई एरर नहीं होता और उसका कोई असर नहीं होता। किसी दूसरे प्रोवाइडर के लिए लिखा अनुरोध अतिरिक्त फ़ील्ड की वजह से विफल नहीं होता।
• ज्ञात फ़ील्ड का गलत JSON प्रकार, या ज़रूरी फ़ील्ड का न होना, 422 से उत्तरित होता है। जो बॉडी वैध JSON नहीं है, उसका उत्तर 400 से दिया जाता है।
• model Models & pricing पर दिए id में से एक है। अपरकेस और लोअरकेस से फ़र्क नहीं पड़ता।

उत्तर JSON होता है, या सर्वर-सेंट इवेंट्स की स्ट्रीम, जब अनुरोध stream को true पर सेट करता है। हर endpoint अपने फ़ॉर्मेट में उत्तर देता है। हर उत्तर में हेडर x-request-id होता है।

अनुरोध किन जाँचों से गुज़रता है

मॉडल चलने से पहले अनुरोध एक तय क्रम में जाँचा जाता है। जो पहली जाँच विफल होती है वही उत्तर देती है, इसलिए 401 से अभी बॉडी के बारे में कुछ पता नहीं चलता।

एरर का रूप

एरर एक JSON ऑब्जेक्ट है जिसमें error होता है, जिसके भीतर type और message होते हैं। /v1/messages उसे उस तरह लपेटता है जैसा Anthropic SDK अपेक्षा करते हैं; बाकी हर पाथ OpenAI का रूप इस्तेमाल करता है।

{
  "error": {
    "type": "invalid_request_error",
    "message": "unknown model: gpt-4o"
  }
}

{
  "type": "error",
  "error": {
    "type": "invalid_request_error",
    "message": "unknown model: gpt-4o"
  }
}

• type और message पढ़ें। code और param केवल कुछ एरर में होते हैं: उन्हें वैकल्पिक मानें। param हमेशा null होता है।
• स्ट्रीम शुरू होने के बाद स्टेटस पहले ही 200 हो चुका होता है। तब विफलता स्ट्रीम के भीतर एक एरर फ़्रेम के रूप में आती है।
• हर एरर उत्तर में हेडर x-request-id होता है।

त्रुटि प्रबंधन

बिलिंग और बैलेंस

• हर अकाउंट का एक बैलेंस होता है, और चैट और API उसे साझा करते हैं: पहले आज का प्लान अलाउंस, फिर खरीदा गया क्रेडिट। API का अपना कोई कोटा नहीं है।
• अनुरोध अपना आउटपुट बजट (max_tokens, डिफ़ॉल्ट 4,096) रिज़र्व करता है और फिर जितने टोकन उसने सच में इस्तेमाल किए उनका शुल्क मॉडल की कीमत पर लगता है।
• हर उत्तर अपनी टोकन गिनती usage में बताता है। Keys & usage पेज बैलेंस और हर अनुरोध की लागत दिखाता है।
• हर अनुरोध समान रूप से पूरा किया जाता है। अनुरोध दर पर एकमात्र सीमा flood protection है: प्रति अकाउंट प्रति मिनट 120 अनुरोध। समानांतर भेजे गए अनुरोध कतार में इंतज़ार करते हैं।

सीमाएँ और बैलेंस मॉडल और कीमतें Keys और उपयोग

मॉडल पर निर्भर फ़ील्ड

हर मॉडल एक ही अनुरोध लेता है। कुछ फ़ील्ड केवल कुछ मॉडल पर असर करते हैं; तालिका बताती है कि कहाँ। endpoint पेज हर फ़ील्ड की सूची देते हैं।

Chat Completions

OpenAI SDK से आ रहे हैं

• बेस URL को https://api.shannon-ai.com/v1 पर सेट करें और key को अपनी Shannon key पर। तब Chat Completions और Responses कॉल SDK के साथ जैसी हैं वैसी काम करती हैं।
• model Shannon id होना चाहिए। gpt-4o जैसे किसी दूसरे प्रोवाइडर के मॉडल नाम का उत्तर 400 और unknown model से दिया जाता है।
• रीज़निंग अपने अलग फ़ील्ड में आती है: संदेश में और स्ट्रीम डेल्टा में content के बगल में reasoning_content।
• स्ट्रीम के अंतिम चंक में हमेशा usage होता है, finish_reason के साथ।
• स्ट्रीम में टूल कॉल एक चंक के रूप में पूरी arguments स्ट्रिंग के साथ आती है।
• उत्तर में एक ही choice होता है।
• OpenAI API के जो पाथ ऊपर की तालिका में नहीं हैं, जैसे /v1/embeddings, उनका उत्तर 404 से दिया जाता है।

Anthropic SDK से आ रहे हैं

• बेस URL को https://api.shannon-ai.com पर सेट करें, /v1 के बिना, और key को अपनी Shannon key पर। SDK इसे x-api-key के रूप में भेजता है।
• model Shannon id होना चाहिए।
• इस API पर max_tokens वैकल्पिक है। इसका डिफ़ॉल्ट 4,096 है।
• उत्तर में प्रकार thinking, text और tool_use के कंटेंट ब्लॉक होते हैं। पहला ब्लॉक हमेशा टेक्स्ट नहीं होता: ब्लॉक type से चुनें।
• stop_reason end_turn या tool_use होता है। Shannon मॉडल की स्ट्रीम max_tokens पर भी खत्म हो सकती है।
• anthropic-version और anthropic-beta स्वीकार किए जाते हैं, इसलिए SDK बिना बदलाव काम करता है। अनुरोध को इनकी ज़रूरत नहीं है।
• /v1/messages पर एरर का रूप Anthropic जैसा है: {"type": "error", "error": {…}}।

जो कोडिंग टूल इन फ़ॉर्मेट को बोलते हैं, वे उसी तरह सेट होते हैं: बेस URL, key, और मॉडल के रूप में एक Shannon id। CLI कोडिंग टूल्स