Chat Completions

POST https://api.shannon-ai.com/v1/chat/completions

सबसे छोटा अनुरोध एक मॉडल id और एक यूज़र संदेश है।

from openai import OpenAI

client = OpenAI(
    api_key="YOUR_API_KEY",
    base_url="https://api.shannon-ai.com/v1",
)

response = client.chat.completions.create(
    model="shannon-3",
    messages=[{"role": "user", "content": "Say hello in one sentence."}],
)

print(response.choices[0].message.content)

import OpenAI from "openai";

const client = new OpenAI({
  apiKey: "YOUR_API_KEY",
  baseURL: "https://api.shannon-ai.com/v1",
});

const response = await client.chat.completions.create({
  model: "shannon-3",
  messages: [{ role: "user", content: "Say hello in one sentence." }],
});

console.log(response.choices[0].message.content);

curl https://api.shannon-ai.com/v1/chat/completions \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "shannon-3",
    "messages": [{"role": "user", "content": "Say hello in one sentence."}]
  }'

उत्तर एक JSON ऑब्जेक्ट है:

{
  "id": "chatcmpl-5f0c1e7a9b3d4c62a8e1f07d2b46c9a3",
  "object": "chat.completion",
  "created": 1791625200,
  "model": "shannon-3",
  "choices": [
    {
      "index": 0,
      "message": {
        "role": "assistant",
        "content": "Hello, it is good to meet you.",
        "reasoning_content": "The user wants a greeting in one sentence. Keep it short and friendly."
      },
      "finish_reason": "stop"
    }
  ],
  "usage": {
    "prompt_tokens": 1184,
    "completion_tokens": 46,
    "total_tokens": 1230
  }
}

हेडर

अनुरोध हेडर

उत्तर हेडर

अनुरोध फ़ील्ड

केवल messages आवश्यक है। लागू करने वाले कॉलम में उन मॉडल के नाम हैं जिन पर कोई फ़ील्ड उत्तर को बदलता है। होस्टेड ओपन-वेट मॉडल मॉडल सूची के बारह id हैं; Shannon 3 परिवार shannon-3, shannon-3-pro, shannon-3.1 और shannon-3.1-pro है। मॉडल और कीमतें

अन्य OpenAI फ़ील्ड, जैसे n, user, stream_options, parallel_tool_calls, presence_penalty, frequency_penalty, logit_bias, logprobs, metadata, store और prompt_cache_key, स्वीकार किए जाते हैं ताकि मौजूदा क्लाइंट कोड बिना बदलाव के चले। ये उत्तर को नहीं बदलते: हमेशा एक ही choice होती है, और स्ट्रीम हमेशा उपयोग की जानकारी के साथ समाप्त होती है।

गलत JSON प्रकार वाला फ़ील्ड, उदाहरण के लिए "max_tokens": "100", 422 लौटाता है। messages के बिना अनुरोध भी यही लौटाता है।

टूल्स, संरचित आउटपुट, रीज़निंग और वेब सर्च, हर एक का अपना पेज है: फ़ंक्शन कॉलिंग, संरचित आउटपुट, रीज़निंग effort, इनबिल्ट Web Search.

विकल्पों के साथ अनुरोध

यह अनुरोध एक सिस्टम संदेश, सैंपलिंग फ़ील्ड और रीज़निंग effort सेट करता है। यह एक होस्टेड ओपन-वेट मॉडल का उपयोग करता है, जो इन सभी को लागू करता है।

from openai import OpenAI

client = OpenAI(
    api_key="YOUR_API_KEY",
    base_url="https://api.shannon-ai.com/v1",
)

response = client.chat.completions.create(
    model="DeepSeek-V4-Flash-0731-W4A16-AUTOROUND-REAP",
    messages=[
        {"role": "system", "content": "You are a physics teacher. Answer in two sentences."},
        {"role": "user", "content": "Why is the sky blue?"},
    ],
    max_tokens=512,
    temperature=0.3,
    top_p=0.9,
    seed=7,
    stop=["\n\n"],
    reasoning_effort="low",
)

message = response.choices[0].message
print(message.reasoning_content)  # the reasoning
print(message.content)            # the answer
print(response.usage)

import OpenAI from "openai";

const client = new OpenAI({
  apiKey: "YOUR_API_KEY",
  baseURL: "https://api.shannon-ai.com/v1",
});

const response = await client.chat.completions.create({
  model: "DeepSeek-V4-Flash-0731-W4A16-AUTOROUND-REAP",
  messages: [
    { role: "system", content: "You are a physics teacher. Answer in two sentences." },
    { role: "user", content: "Why is the sky blue?" },
  ],
  max_tokens: 512,
  temperature: 0.3,
  top_p: 0.9,
  seed: 7,
  stop: ["\n\n"],
  reasoning_effort: "low",
});

const message = response.choices[0].message;
console.log(message.reasoning_content); // the reasoning
console.log(message.content);           // the answer
console.log(response.usage);

curl https://api.shannon-ai.com/v1/chat/completions \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "DeepSeek-V4-Flash-0731-W4A16-AUTOROUND-REAP",
    "messages": [
      {"role": "system", "content": "You are a physics teacher. Answer in two sentences."},
      {"role": "user", "content": "Why is the sky blue?"}
    ],
    "max_tokens": 512,
    "temperature": 0.3,
    "top_p": 0.9,
    "seed": 7,
    "stop": ["\n\n"],
    "reasoning_effort": "low"
  }'

उत्तर का रूप ऊपर जैसा ही है। होस्टेड ओपन-वेट मॉडल पर इसका usage दो विवरण और जोड़ता है: कैश से पढ़े गए प्रॉम्प्ट टोकन और रीज़निंग पर खर्च हुए टोकन।

{
  "usage": {
    "prompt_tokens": 31,
    "completion_tokens": 62,
    "total_tokens": 93,
    "prompt_tokens_details": {
      "cached_tokens": 0
    },
    "completion_tokens_details": {
      "reasoning_tokens": 21
    }
  }
}

आउटपुट की लंबाई

max_tokens दो काम करता है। पहला, अनुरोध शुरू होते समय आपके बैलेंस में से इतने टोकन अलग रख लिए जाते हैं। उत्तर पूरा होने पर वह मात्रा अनुरोध द्वारा उपयोग किए गए टोकन से बदल दी जाती है। यदि max_tokens आपके बैलेंस में बचे हिस्से से बड़ा है, तो अनुरोध 429 Quota exceeded लौटाता है, भले ही उत्तर खुद समा जाता। कम अलग रखने के लिए कम max_tokens भेजें।

इस endpoint पर shannon-coder-1 अलग तरह से गिना जाता है: हर अनुरोध आपके प्लान की एक Shannon Coder कॉल है, और उसके लिए कोई टोकन अलग नहीं रखे जाते। सीमाएँ और बैलेंस

दूसरा, यह इन मॉडल पर उत्तर की लंबाई सीमित करता है:

max_tokens या max_completion_tokens के बिना मान 4,096 होता है। shannon-coder-1 पर यह 65,536 है।

संदेश

हर संदेश एक ऑब्जेक्ट है जिसमें role और content होता है। content एक स्ट्रिंग है, या भागों की ऐरे जब संदेश में टेक्स्ट से ज़्यादा कुछ हो।

Shannon 3 परिवार के id के साथ, जो निर्देश अनिवार्य हैं उन्हें user संदेश में रखें।

Shannon टियर पर यूज़र टेक्स्ट और tools के बिना अनुरोध 400 No user message provided लौटाता है।

कंटेंट भाग

साइज़, सीमाओं और सभी रूपों की पूरी सूची का अपना पेज है। इमेज और फ़ाइलें

उत्तर ऑब्जेक्ट

समाप्ति के कारण

बिना स्ट्रीम वाला उत्तर stop या tool_calls बताता है।

उपयोग

होस्टेड ओपन-वेट मॉडल पर prompt_tokens आपके संदेशों और टूल परिभाषाओं को मॉडल के अपने टोकनाइज़र से गिनकर, साथ में किसी भी इमेज के टोकन जोड़कर बनता है। टोकन गिनने वाले endpoints भेजने से पहले यही संख्या लौटाते हैं। टोकन गिनती

Shannon टियर पर prompt_tokens वह सब गिनता है जो मॉडल ने उत्तर लिखने के लिए पढ़ा, इसलिए यह अकेले आपके संदेशों के टेक्स्ट से बड़ा होता है।

स्ट्रीमिंग

stream को true पर सेट करने पर उत्तर chat.completion.chunk इवेंट के रूप में आता है और data: [DONE] पर समाप्त होता है। उससे पहले का आखिरी चंक finish_reason और usage ले जाता है; किसी stream_options की ज़रूरत नहीं। चंक के रूप, keep-alive लाइनों और स्ट्रीम के भीतर की त्रुटियों का अपना पेज है। स्ट्रीमिंग

त्रुटियाँ

त्रुटि एक JSON ऑब्जेक्ट है जिसमें error सदस्य होता है। जाँचें इस क्रम में चलती हैं: API key, अनुरोध बॉडी, मॉडल id, फिर बैलेंस। तालिका वह दिखाती है जो यह endpoint सबसे ज़्यादा लौटाता है। पूरी सूची, और किसे दोबारा आज़माना है, इसका अपना पेज है। त्रुटि प्रबंधन

{
  "error": {
    "type": "invalid_request_error",
    "message": "unknown model: no-such-model"
  }
}