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 हो। मोडल र मूल्य

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

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

टुल, स्ट्रक्चर्ड आउटपुट, रिजनिङ र वेब खोज प्रत्येकको आफ्नै पेज छ: फङ्क्शन कलिङ, संरचित आउटपुट, रिजनिङ एफर्ट, निर्मित वेब खोज.

विकल्पहरूसहितको अनुरोध

यो अनुरोधले सिस्टम सन्देश, स्याम्पलिङ फिल्डहरू र रिजनिङ एफर्ट सेट गर्छ। यसले होस्ट गरिएको ओपन-वेट मोडल प्रयोग गर्छ, जसले ती सबै लागू गर्छ।

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 पठाउनुहोस्।

यो इन्डपोइन्टमा shannon-coder-1 फरक तरिकाले गणना गरिन्छ: हरेक अनुरोध तपाईंको प्लानको एउटा Shannon Coder कल हो, र यसका लागि कुनै टोकन छुट्याइँदैन। सीमा र ब्यालेन्स

दोस्रो, यसले यी मोडलहरूमा जवाफको लम्बाइ सीमित गर्छ:

max_tokens वा max_completion_tokens बिना मान 4,096 हुन्छ। shannon-coder-1 मा यो 65,536 हो।

Messages

हरेक सन्देश role र content भएको अब्जेक्ट हो। content स्ट्रिङ हो, वा सन्देशले टेक्स्टभन्दा बढी बोक्दा भागहरूको एरे।

Shannon 3 परिवारको id सँग, अनिवार्य रूपमा पालना हुनुपर्ने निर्देशनहरू user सन्देशमा राख्नुहोस्।

Shannon तहहरूमा प्रयोगकर्ता टेक्स्ट र tools नभएको अनुरोधले 400 No user message provided फर्काउँछ।

कन्टेन्ट भागहरू

साइज, सीमा र रूपहरूको पूर्ण सूचीको आफ्नै पेज छ। छवि र फाइलहरू

जवाफ अब्जेक्ट

समाप्ति कारणहरू

स्ट्रिम नगरिएको जवाफले stop वा tool_calls रिपोर्ट गर्छ।

Usage

होस्ट गरिएका ओपन-वेट मोडलहरूमा, prompt_tokens तपाईंका सन्देश र टुल परिभाषाहरू मोडलकै टोकनाइजरले गनिएको र कुनै छविका टोकनहरू थपिएको संख्या हो। टोकन गणना इन्डपोइन्टहरूले पठाउनु अघि उही संख्या फर्काउँछन्। टोकन गणना

Shannon तहहरूमा, prompt_tokens ले जवाफ लेख्न मोडलले पढेका सबै कुरा गन्छ, त्यसैले यो तपाईंका सन्देशहरूको टेक्स्ट मात्रभन्दा ठूलो हुन्छ।

स्ट्रिमिङ

stream लाई true सेट गर्दा जवाफ chat.completion.chunk इभेन्टका रूपमा आइपुग्छ र data: [DONE] सँग सकिन्छ। त्यसअघिको अन्तिम चंकले finish_reason र usage बोक्छ; कुनै stream_options चाहिँदैन। चंकको आकार, कीप-अलाइभ लाइन र स्ट्रिमभित्रका त्रुटिहरूको आफ्नै पेज छ। स्ट्रिमिङ

त्रुटिहरू

त्रुटि error सदस्य भएको JSON अब्जेक्ट हो। जाँचहरू यही क्रममा चल्छन्: API की, अनुरोध बडी, मोडल id, त्यसपछि ब्यालेन्स। तालिकाले यो इन्डपोइन्टले प्रायः फर्काउने कुराहरू सूचीबद्ध गर्छ। के पुनः प्रयास गर्ने भन्ने सहितको पूर्ण सूचीको आफ्नै पेज छ। त्रुटि व्यवस्थापन

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