Chat Completions

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

කුඩාම ඉල්ලීම යනු model 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 object එකකි:

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

Headers

ඉල්ලීම් headers

පිළිතුරු headers

ඉල්ලීම් fields

අවශ්‍ය වන්නේ messages පමණි. Applied by තීරුවේ field එකක් පිළිතුර වෙනස් කරන models නම් කර ඇත. අපගේ සේවාදායකවල ධාවනය වන open-weight models යනු model ලැයිස්තුවේ ඇති id දොළහයි; Shannon 3 පවුල යනු shannon-3, shannon-3-pro, shannon-3.1 සහ shannon-3.1-pro ය. Models සහ මිල ගණන්

n, user, stream_options, parallel_tool_calls, presence_penalty, frequency_penalty, logit_bias, logprobs, metadata, store සහ prompt_cache_key වැනි අනෙකුත් OpenAI fields, දැනට ඇති client code වෙනසක් නොමැතිව ක්‍රියා කිරීම සඳහා පිළිගනී. ඒවා පිළිතුර වෙනස් නොකරයි: සෑම විටම එක choice එකක් පමණක් ඇති අතර, stream එකක් සෑම විටම usage සමඟ අවසන් වේ.

වැරදි JSON type එකක් ඇති field එකකට, උදාහරණයක් ලෙස "max_tokens": "100", 422 ලැබේ. messages නැති ඉල්ලීමකට ද එසේමය.

Tools, ව්‍යුහගත output, තර්කනය සහ web search වලට එකිනෙකට තමන්ගේම පිටුවක් ඇත: කාර්ය කැඳවීම, ව්‍යුහගත ප්‍රතිදාන, Reasoning effort, වෙබ් සෙවීම.

විකල්ප සහිත ඉල්ලීමක්

මෙම ඉල්ලීම system පණිවිඩයක්, sampling fields සහ reasoning effort එක සකසයි. එය ඒ සියල්ල ක්‍රියාත්මක කරන, අපගේ සේවාදායකවල ධාවනය වන open-weight model එකක් භාවිතා කරයි.

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 models මත එහි usage විස්තර දෙකක් එකතු කරයි: cache එකෙන් කියවූ prompt tokens සහ තර්කනයට වැය වූ tokens.

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

Output දිග

max_tokens දේවල් දෙකක් කරයි. පළමුව, ඉල්ලීම ආරම්භ වන විට ඔබේ ශේෂයෙන් වෙන් කර තබන tokens ගණන එයයි. පිළිතුර සම්පූර්ණ වූ විට, එම ප්‍රමාණය ඉල්ලීම භාවිතා කළ tokens මගින් ප්‍රතිස්ථාපනය වේ. max_tokens ඔබේ ශේෂයේ ඉතිරි ප්‍රමාණයට වඩා විශාල නම්, පිළිතුරම ඊට ඇතුළත් වුවත් ඉල්ලීමට 429 Quota exceeded ලැබේ. අඩුවෙන් වෙන් කිරීමට අඩු max_tokens යවන්න.

මෙම endpoint හි shannon-coder-1 වෙනස් ලෙස ගණන් කෙරේ: සෑම ඉල්ලීමක්ම ඔබේ සැලසුමේ Shannon Coder calls වලින් එකක් වන අතර ඒ සඳහා tokens වෙන් කර නොතබයි. සීමා සහ ශේෂය

දෙවනුව, එය මෙම models මත පිළිතුරේ දිග සීමා කරයි:

max_tokens හෝ max_completion_tokens නොමැතිව අගය 4,096 වේ. shannon-coder-1 මත එය 65,536 වේ.

පණිවිඩ

සෑම පණිවිඩයක්ම role එකක් සහ content එකක් ඇති object එකකි. content යනු string එකක්, නැතහොත් පණිවිඩය පෙළට වඩා යමක් රැගෙන යන විට කොටස් array එකකි.

Shannon 3 පවුලේ id එකක් සමඟ, අනිවාර්යයෙන් පිළිපැදිය යුතු උපදෙස් user පණිවිඩයට ඇතුළත් කරන්න.

Shannon tiers මත user පෙළක් සහ tools නැති ඉල්ලීමකට 400 No user message provided ලැබේ.

අන්තර්ගත කොටස්

ප්‍රමාණ, සීමා සහ ආකාර සියල්ලේ සම්පූර්ණ ලැයිස්තුවට තමන්ගේම පිටුවක් ඇත. රූප සහ ගොනු

පිළිතුරු object එක

අවසන් වීමේ හේතු

Stream නොකළ පිළිතුරක් stop හෝ tool_calls වාර්තා කරයි.

භාවිතය (Usage)

අපගේ සේවාදායකවල ධාවනය වන open-weight models මත, prompt_tokens යනු ඔබේ පණිවිඩ සහ tool අර්ථ දැක්වීම් model එකේම tokenizer එකෙන් ගණනය කළ ප්‍රමාණයට රූපවල tokens එකතු කිරීමයි. Token ගණන් කිරීමේ endpoints ඔබ යැවීමට පෙර එම අගයම ආපසු දෙයි. Token ගණන් කිරීම

Shannon tiers මත, prompt_tokens පිළිතුර ලිවීමට model එක කියවූ සියල්ල ගණන් ගනී, එබැවින් එය ඔබේ පණිවිඩවල පෙළට පමණක් වඩා විශාල වේ.

Streaming

stream true ලෙස සකසා ඇති විට පිළිතුර chat.completion.chunk events ලෙස පැමිණ data: [DONE] සමඟ අවසන් වේ. ඊට පෙර අවසාන chunk එක finish_reason සහ usage රැගෙන යයි; stream_options අවශ්‍ය නැත. Chunk හැඩතල, keep-alive පේළි සහ stream එකක් තුළ දෝෂ සඳහා තමන්ගේම පිටුවක් ඇත. ස්ට්‍රීමිං

දෝෂ

දෝෂයක් යනු error member එකක් සහිත JSON object එකකි. පරීක්ෂා ක්‍රියාත්මක වන්නේ මෙම පිළිවෙලටයි: API key, ඉල්ලීමේ body, model id, ඉන්පසු ශේෂය. වගුවේ මෙම endpoint එක බොහෝ විට ආපසු දෙන දේ ලැයිස්තුගත කර ඇත. නැවත උත්සාහ කළ යුතු දේ සහිත සම්පූර්ණ ලැයිස්තුවට තමන්ගේම පිටුවක් ඇත. දෝෂ

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