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 మాత్రమే తప్పనిసరి. వర్తింపజేసేవి కాలమ్ ఒక ఫీల్డ్ సమాధానాన్ని మార్చే మోడల్స్‌ను పేర్కొంటుంది. హోస్ట్ చేసిన ఓపెన్-వెయిట్ మోడల్స్ అంటే మోడల్ జాబితాలోని పన్నెండు ids; 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 లేని రిక్వెస్ట్‌కు కూడా అంతే.

టూల్స్, నిర్మిత అవుట్‌పుట్, రీజనింగ్ మరియు వెబ్ శోధన ప్రతిదానికీ ప్రత్యేక పేజీ ఉంది: ఫంక్షన్ కాలింగ్, నిర్మిత అవుట్‌పుట్‌లు, రీజనింగ్ effort, వెబ్ శోధన.

ఎంపికలతో ఒక రిక్వెస్ట్

ఈ రిక్వెస్ట్ system మెసేజ్, శాంప్లింగ్ ఫీల్డ్‌లు మరియు రీజనింగ్ 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 రెండు వివరాలను జోడిస్తుంది: క్యాష్ నుండి చదివిన ప్రాంప్ట్ tokens మరియు రీజనింగ్‌పై ఖర్చు చేసిన tokens.

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

అవుట్‌పుట్ పొడవు

max_tokens రెండు పనులు చేస్తుంది. మొదటిది, రిక్వెస్ట్ ప్రారంభమైనప్పుడు మీ బ్యాలెన్స్ నుండి పక్కన పెట్టే tokens సంఖ్య ఇదే. సమాధానం పూర్తయినప్పుడు, ఆ మొత్తం రిక్వెస్ట్ ఉపయోగించిన tokens తో భర్తీ అవుతుంది. max_tokens మీ బ్యాలెన్స్‌లో మిగిలిన దానికంటే పెద్దదైతే, సమాధానం సరిపోయేదైనా సరే రిక్వెస్ట్‌కు 429 Quota exceeded వస్తుంది. తక్కువ పక్కన పెట్టడానికి తక్కువ max_tokens పంపండి.

ఈ ఎండ్‌పాయింట్‌లో shannon-coder-1 వేరే విధంగా లెక్కించబడుతుంది: ప్రతి రిక్వెస్ట్ మీ ప్లాన్ యొక్క Shannon Coder కాల్స్‌లో ఒకటి, మరియు దాని కోసం tokens ఏవీ పక్కన పెట్టబడవు. పరిమితులు మరియు బ్యాలెన్స్

రెండవది, ఈ మోడల్స్‌లో ఇది సమాధానం పొడవును పరిమితం చేస్తుంది:

max_tokens లేదా max_completion_tokens లేకపోతే, విలువ 4,096. shannon-coder-1 లో అది 65,536.

Messages

ప్రతి మెసేజ్ role మరియు content ఉన్న ఆబ్జెక్ట్. content ఒక string, లేదా మెసేజ్ టెక్స్ట్ కంటే ఎక్కువ కలిగి ఉన్నప్పుడు భాగాల array.

Shannon 3 ఫ్యామిలీ id తో, తప్పక పాటించాల్సిన సూచనలను user మెసేజ్‌లో ఉంచండి.

Shannon టియర్‌లలో యూజర్ టెక్స్ట్ మరియు tools లేని రిక్వెస్ట్‌కు 400 No user message provided వస్తుంది.

కంటెంట్ భాగాలు

పరిమాణాలు, పరిమితులు మరియు రూపాల పూర్తి జాబితాకు ప్రత్యేక పేజీ ఉంది. చిత్రాలు మరియు ఫైళ్లు

సమాధాన ఆబ్జెక్ట్

ముగింపు కారణాలు

స్ట్రీమ్ కాని సమాధానం stop లేదా tool_calls ను నివేదిస్తుంది.

వినియోగం

హోస్ట్ చేసిన ఓపెన్-వెయిట్ మోడల్స్‌లో, prompt_tokens అంటే మీ మెసేజ్‌లు మరియు టూల్ నిర్వచనాలను మోడల్ సొంత టోకెనైజర్‌తో లెక్కించినది, ఏవైనా చిత్రాల tokens తో సహా. మీరు పంపే ముందే tokens లెక్కింపు ఎండ్‌పాయింట్‌లు అదే సంఖ్యను తిరిగి ఇస్తాయి. Token లెక్కింపు

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