Chat Completions

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

सर्वात लहान रिक्वेस्ट म्हणजे मॉडेल id आणि एक user संदेश.

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 आवश्यक आहे. लागू करणारे स्तंभ ज्या मॉडेल्सवर फील्ड उत्तर बदलते त्यांची नावे देतो. होस्ट केलेली open-weight मॉडेल्स म्हणजे मॉडेल यादीतील बारा 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 असते, आणि स्ट्रीम नेहमी usage सह संपतो.

चुकीचा JSON प्रकार असलेले फील्ड, उदाहरणार्थ "max_tokens": "100", 422 परत करते. messages नसलेली रिक्वेस्टही.

टूल्स, स्ट्रक्चर्ड आउटपुट, रीझनिंग आणि वेब सर्च यांची प्रत्येकी स्वतंत्र पाने आहेत: फंक्शन कॉलिंग, संरचित आउटपुट्स, रीझनिंग effort, Built‑in Web Search.

पर्यायांसह रिक्वेस्ट

ही रिक्वेस्ट system संदेश, सॅम्पलिंग फील्ड्स आणि रीझनिंग effort सेट करते. ती होस्ट केलेले open-weight मॉडेल वापरते, जे सर्व लागू करते.

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

उत्तराची रचना वरीलप्रमाणेच आहे. होस्ट केलेल्या open-weight मॉडेल्सवर त्याच्या 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 पाठवा.

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 सांगते.

वापर

होस्ट केलेल्या open-weight मॉडेल्सवर prompt_tokens म्हणजे तुमचे संदेश आणि टूल व्याख्या मॉडेलच्या स्वतःच्या टोकनायझरने मोजलेल्या, तसेच कोणत्याही इमेजचे टोकन्स. टोकन मोजणी एंडपॉइंट तुम्ही पाठवण्यापूर्वी तीच संख्या परत करतात. टोकन मोजणी

Shannon टियर्सवर prompt_tokens मॉडेलने उत्तर लिहिण्यासाठी वाचलेले सर्व काही मोजतो, त्यामुळे तो फक्त तुमच्या संदेशांच्या मजकुरापेक्षा मोठा असतो.

स्ट्रीमिंग

stream true वर सेट केल्यावर उत्तर chat.completion.chunk इव्हेंट्स म्हणून येते आणि data: [DONE] ने संपते. त्याच्या आधीचा शेवटचा चंक finish_reason आणि usage देतो; stream_options ची गरज नसते. चंकची रचना, keep-alive ओळी आणि स्ट्रीममधील एरर यांचे स्वतःचे पान आहे. स्ट्रीमिंग

एरर

एरर म्हणजे error सदस्य असलेला JSON ऑब्जेक्ट. तपासण्या या क्रमाने चालतात: API की, रिक्वेस्ट बॉडी, मॉडेल id, मग बॅलन्स. टेबल हा एंडपॉइंट सर्वाधिक वेळा काय परत करतो ते दाखवते. संपूर्ण यादी, काय पुन्हा प्रयत्न करायचे यासह, स्वतंत्र पानावर आहे. त्रुटी हाताळणी

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