Chat Completions

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

تر ټولو کوچنۍ غوښتنه د ماډل id او یو user message دی.

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

Headers

د غوښتنې headers

د ځواب headers

د غوښتنې ساحې

یوازې 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، منل کیږي ترڅو شته client کوډ بې بدلون چلیږي. دوی ځواب نه بدلوي: تل یوه choice وي، او stream تل په usage پای ته رسیږي.

هغه ساحه چې د JSON غلط ډول ولري، د مثال په توګه "max_tokens": "100"، 422 بیرته ورکوي. هغه غوښتنه چې messages نه لري هم همداسې.

Tools، جوړښت لرونکی output، reasoning او web search هر یو خپله جلا پاڼه لري: فنکشن زنګ وهل, جوړښت شوي محصولات, د reasoning effort, جوړ شوی ویب لټون.

غوښتنه د اختیارونو سره

دا غوښتنه system message، د sampling ساحې او د reasoning 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"
  }'

ځواب هماغه بڼه لري لکه پورته. د هغه usage په کوربه شوو open-weight ماډلونو کې دوه جزئیات زیاتوي: له cache څخه لوستل شوي prompt ټوکنونه او هغه ټوکنونه چې په reasoning لګیدلي.

{
  "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 دوه کارونه کوي. لومړی، دا د ټوکنونو شمیر دی چې کله غوښتنه پیلیږي ستاسو له بیلانس څخه ساتل کیږي. کله چې ځواب بشپړ شي، دا مقدار د هغو ټوکنونو سره بدلیږي چې غوښتنې کارولي. که max_tokens د هغه څه څخه لوی وي چې ستاسو له بیلانس څخه پاتې دي، غوښتنه 429 Quota exceeded بیرته ورکوي حتی که ځواب پخپله ځای شوی وای. لږ ساتلو لپاره ټیټ max_tokens ولیږئ.

shannon-coder-1 پدې endpoint کې بل ډول شمیرل کیږي: هره غوښتنه ستاسو د پلان د Shannon Coder calls څخه یو call دی، او د هغې لپاره هیڅ ټوکنونه نه ساتل کیږي. حدونه او بیلانس

دویم، دا پدې ماډلونو کې د ځواب اوږدوالی محدودوي:

پرته له max_tokens یا max_completion_tokens، ارزښت 4,096 دی. په shannon-coder-1 کې 65,536 دی.

Messages

هر message یو څیز دی چې role او content لري. content یو string دی، یا د برخو لړۍ کله چې message له متن زیات څه لیږدوي.

د Shannon 3 کورنۍ id سره، هغه لارښوونې چې باید وساتل شي user message کې ولیکئ.

د Shannon په کچو کې هغه غوښتنه چې د کاروونکي متن او tools نه لري 400 No user message provided بیرته ورکوي.

د منځپانګې برخې

اندازې، حدونه او د ټولو بڼو بشپړ لیست خپله جلا پاڼه لري. انځورونه او فایلونه

د ځواب څیز

د پای دلیلونه

هغه ځواب چې stream نه وي stop یا tool_calls راپور کوي.

Usage

په کوربه شوو open-weight ماډلونو کې، prompt_tokens ستاسو messages او د tool تعریفونه دي چې د ماډل د خپل tokenizer سره شمیرل شوي، پلس د هر انځور ټوکنونه. د ټوکنونو شمېرنې endpoints مخکې له لیږلو همدا شمیره بیرته ورکوي. د ټوکنونو شمېرنه

د Shannon په کچو کې، prompt_tokens هر هغه څه شمیري چې ماډل د ځواب د لیکلو لپاره لوستي، نو دا یوازې د ستاسو د messages د متن څخه لوی دی.

Streaming

کله چې stream په true ټاکل شي ځواب د chat.completion.chunk events په توګه رارسیږي او په data: [DONE] پای ته رسیږي. ورڅخه مخکې وروستی chunk finish_reason او usage لیږدوي؛ هیڅ stream_options ته اړتیا نشته. د chunk بڼې، keep-alive کرښې او د stream دننه تېروتنې خپله جلا پاڼه لري. جریان

تېروتنې

تېروتنه د JSON څیز دی چې error غړی لري. چکونه په دې ترتیب چلیږي: API کیلي، د غوښتنې بدنه، د ماډل id، بیا بیلانس. جدول هغه څه لیست کوي چې دا endpoint تر ټولو ډیر بیرته ورکوي. بشپړ لیست، د دې سره چې څه بیا هڅه شي، خپله جلا پاڼه لري. د تېروتنې اداره کول

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