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

Headers

Headers ی داواکاری

Headers ی وەڵام

بوارەکانی داواکاری

تەنها messages پێویستە. ستوونی جێبەجێکراو لەلایەن ئەو مۆدێلانە ناو دەبات کە field ەکە وەڵامەکەیان تێدا دەگۆڕێت. مۆدێلە open-weight هۆستکراوەکان دوانزە id ی لیستی مۆدێلەکانن؛ بنەماڵەی Shannon 3 بریتییە لە shannon-3 و shannon-3-pro و shannon-3.1 و shannon-3.1-pro. مۆدێل و نرخ

field ەکانی تری OpenAI، وەک n و user و stream_options و parallel_tool_calls و presence_penalty و frequency_penalty و logit_bias و logprobs و metadata و store و prompt_cache_key، قبوڵ دەکرێن تا کۆدی کلاینتی هەبوو بێ گۆڕانکاری کار بکات. وەڵامەکە ناگۆڕن: هەمیشە یەک choice هەیە، و stream هەمیشە بە usage کۆتایی دێت.

بوارێک بە جۆری JSON ی هەڵە، بۆ نموونە "max_tokens": "100"، 422 دەگەڕێنێتەوە. داواکارییەک بەبێ messages یش هەروایە.

ئامراز و دەرچووی ڕێکخراو و بیرکردنەوە و گەڕانی وێب هەریەکەیان لاپەڕەی تایبەتی خۆیان هەیە: Bangkirina fonksiyonê, Derketinên strukturkirî, ئاستی بیرکردنەوە, Lêgerîna webê.

داواکارییەک لەگەڵ بژاردەکان

ئەم داواکارییە نامەیەکی system، بوارەکانی sampling و ئاستی بیرکردنەوە دادەنێت. مۆدێلێکی 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 ـە میوانداریکراوەکان دوو وردەکاری زیاد دەکات: تۆکنەکانی prompt کە لە cache خوێندراونەتەوە و ئەو تۆکنانەی بۆ بیرکردنەوە خەرج کراون.

{
  "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 ی پلانەکەت، و هیچ تۆکنێکی بۆ ڕانەگیراوە. سنوور و باڵانس

دووەم، درێژی وەڵام لەسەر ئەم مۆدێلانە سنووردار دەکات:

بەبێ max_tokens یان max_completion_tokens، بەهاکە 4,096 ە. لەسەر shannon-coder-1 ئەوە 65,536 ە.

نامەکان

هەر نامەیەک ئۆبجێکتێکە بە role و content. content string ێکە، یان ئارەیەک لە بەشەکان کاتێک نامەکە زیاتر لە دەق هەڵدەگرێت.

لەگەڵ id ی بنەماڵەی Shannon 3، ئەو ڕێنماییانەی دەبێت بمێنن بخەرە ناو نامەی user.

لەسەر ئاستەکانی Shannon داواکارییەک بەبێ دەقی بەکارهێنەر و بەبێ tools پەیامی 400 No user message provided دەگەڕێنێتەوە.

بەشەکانی ناوەڕۆک

قەبارە، سنوورەکان و لیستی تەواوی شێوازەکان لاپەڕەی تایبەتی خۆیان هەیە. وێنە و فایلەکان

ئۆبجێکتی وەڵام

هۆکارەکانی کۆتاییهاتن

وەڵامێک کە stream نەکرابێت stop یان tool_calls ڕاپۆرت دەکات.

بەکارهێنان

لەسەر مۆدێلە open-weight ـە میوانداریکراوەکان، prompt_tokens نامەکانت و پێناسەکانی ئامرازەکانە کە بە tokenizer ی خودی مۆدێلەکە هەژمار کراون، لەگەڵ تۆکنەکانی هەر وێنەیەک. endpoint ـەکانی هەژمارکردنی تۆکن هەمان ژمارە دەگەڕێننەوە پێش ئەوەی بینێریت. هەژمارکردنی تۆکن

لەسەر ئاستەکانی Shannon، prompt_tokens هەموو ئەو شتانە هەژمار دەکات کە مۆدێلەکە بۆ نووسینی وەڵامەکە خوێندوویەتییەوە، بۆیە لە دەقی نامەکانت بە تەنها گەورەترە.

Streaming

کاتێک stream لەسەر true دابنرێت وەڵامەکە وەک ڕووداوەکانی chat.completion.chunk دێت و بە data: [DONE] کۆتایی دێت. دوایین chunk پێش ئەو finish_reason و usage هەڵدەگرێت؛ پێویستی بە stream_options نییە. شێوەی chunk ـەکان، هێڵەکانی keep-alive و هەڵەکانی ناو stream لاپەڕەی تایبەتی خۆیان هەیە. Streaming

هەڵەکان

هەڵە ئۆبجێکتێکی JSON ە لەگەڵ ئەندامی error. پشکنینەکان بەم ڕیزبەندییە ئەنجام دەدرێن: کلیلی API، body ی داواکاری، id ی مۆدێل، پاشان باڵانس. خشتەکە ئەوە لیست دەکات کە ئەم endpoint ە زۆرتر دەیگەڕێنێتەوە. لیستی تەواو، لەگەڵ ئەوەی کامیان دووبارە بکرێتەوە، لاپەڕەی تایبەتی خۆی هەیە. Çewtî

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