सारांश

इन्डपोइन्टहरू

हरेक इन्डपोइन्ट एउटै बेस URL मुनि छ र HTTPS मार्फत सेवा गरिन्छ।

https://api.shannon-ai.com

टेक्स्ट उत्पन्न गर्ने तीनवटै इन्डपोइन्टले उही मोडलहरूमा पुग्छन्। तपाईंको कोडले पहिल्यै प्रयोग गरिरहेको ढाँचाको इन्डपोइन्ट छान्नुहोस्।

अनुरोधका आधारभूत कुरा

• हरेक POST को बडी 32 MiB सम्मको एउटा JSON अब्जेक्ट हुन्छ।
• API ले नचिन्ने फिल्डले कुनै त्रुटि ल्याउँदैन र कुनै प्रभाव पार्दैन। अर्को प्रदायकका लागि लेखिएको अनुरोध अतिरिक्त फिल्डका कारण असफल हुँदैन।
• गलत JSON प्रकार भएको चिनिएको फिल्ड, वा हराएको आवश्यक फिल्डलाई 422 सहित जवाफ दिइन्छ। मान्य JSON नभएको बडीलाई 400 सहित जवाफ दिइन्छ।
• model Models & pricing मा भएका id मध्ये एउटा हो। ठूलो र सानो अक्षरले फरक पार्दैन।

जवाफ JSON हुन्छ, वा अनुरोधले stream लाई true सेट गर्दा सर्भर-सेन्ट इभेन्टको स्ट्रिम हुन्छ। हरेक इन्डपोइन्टले आफ्नै ढाँचामा जवाफ दिन्छ। हरेक जवाफमा x-request-id हेडर हुन्छ।

अनुरोधले के पार गर्छ

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

त्रुटिको आकार

त्रुटि type र message बोक्ने error भएको JSON अब्जेक्ट हो। /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 पेजले ब्यालेन्स र हरेक अनुरोधको लागत देखाउँछ।
• हरेक अनुरोध बराबर सेवा पाउँछ। अनुरोध दरको एकमात्र सीमा फ्लड प्रोटेक्सन हो: प्रति खाता प्रति मिनेट 120 अनुरोध। समानान्तर पठाइएका अनुरोधहरू लाइनमा पर्खन्छन्।

सीमा र ब्यालेन्स मोडल र मूल्य की र प्रयोग

मोडलमा निर्भर हुने फिल्डहरू

हरेक मोडलले उही अनुरोध लिन्छ। केही फिल्ड केही मोडलमा मात्र प्रभावकारी हुन्छन्; तालिकाले कहाँ भनेर बताउँछ। इन्डपोइन्ट पेजहरूले हरेक फिल्ड सूचीबद्ध गर्छन्।

Chat Completions

OpenAI SDK बाट आउँदा

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

Anthropic SDK बाट आउँदा

• बेस URL https://api.shannon-ai.com मा, /v1 बिना, र की आफ्नो Shannon कीमा सेट गर्नुहोस्। 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, की, र मोडलका रूपमा Shannon id। CLI कोडिङ टुलहरू