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 міндетті. Қолданады бағанында өріс жауапты өзгертетін модельдер аталған. Hosted open-weight модельдер — модельдер тізіміндегі он екі 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 жоқ сұрау да солай.

Құралдардың, құрылымдалған шығыстың, пайымдаудың және веб іздеудің әрқайсысының өз беті бар: Функция шақыру, Құрылымдалған нәтижелер, Пайымдау күші, Кіріктірілген веб іздеу.

Параметрлері бар сұрау

Бұл сұрау system хабарламасын, сэмплинг өрістерін және пайымдау күшін орнатады. Ол барлығын қолданатын hosted 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"
  }'

Жауап жоғардағыдай пішінде. Hosted open-weight модельдерде оның 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 бұл endpoint-те басқаша есептеледі: әр сұрау жоспарыңыздың Shannon Coder шақыруларының бірі болады және оған токен бөлек сақталмайды. Шектеулер және баланс

Екіншіден, ол мына модельдерде жауап ұзындығын шектейді:

max_tokens немесе max_completion_tokens болмаса, мән 4,096. shannon-coder-1 үшін ол 65,536.

Хабарламалар

Әр хабарлама — role және content бар нысан. content — жол, немесе хабарлама мәтіннен басқаны да алып жүрсе, бөліктер массиві.

Shannon 3 отбасының id-імен орындалуы міндетті нұсқауларды user хабарламасына қойыңыз.

Shannon деңгейлерінде пайдаланушы мәтіні де, tools та жоқ сұрау 400 No user message provided қайтарады.

Мазмұн бөліктері

Өлшемдердің, шектеулердің және формалардың толық тізімінің өз беті бар. Суреттер және файлдар

Жауап нысаны

Аяқталу себептері

Стримсіз жауап stop немесе tool_calls хабарлайды.

Usage

Hosted open-weight модельдерде prompt_tokens — хабарламаларыңыз бен құрал анықтамалары модельдің өз токенайзерімен есептелгені, плюс кез келген суреттердің токендері. Токен санау endpoint-тері жібермес бұрын дәл сол санды қайтарады. Токендерді санау

Shannon деңгейлерінде prompt_tokens модель жауап жазу үшін оқыған бәрін есептейді, сондықтан ол тек хабарламаларыңыздың мәтінінен үлкен.

Streaming

stream мәні true болғанда жауап chat.completion.chunk оқиғалары ретінде келіп, data: [DONE] жолымен аяқталады. Оның алдындағы соңғы бөлік finish_reason және usage алып жүреді; stream_options қажет емес. Бөлік пішіндерінің, keep-alive жолдарының және стрим ішіндегі қателердің өз беті бар. Стриминг

Қателер

Қате — error мүшесі бар JSON нысаны. Тексерулер мына ретпен орындалады: API кілті, сұрау денесі, модель id-і, содан кейін баланс. Кестеде осы endpoint ең жиі қайтаратындар берілген. Толық тізімнің, нені қайталау керегімен бірге, өз беті бар. Қателерді өңдеу

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