Chat Completions

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

Ìbéèrè tó kéré jù jẹ́ id model àti ìfiránṣẹ́ user kan.

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."}]
  }'

Èsì náà jẹ́ object JSON kan:

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

Àwọn header

Àwọn header ìbéèrè

Àwọn header èsì

Àwọn field ìbéèrè

messages nìkan ni a nílò. Ọ̀wọ́n Ó ń ṣiṣẹ́ lórí ń dárúkọ àwọn model tí field kan ti yí èsì padà. Àwọn model open-weight tí a gbàlejò ni id méjìlá inú àtòkọ model; ìdílé Shannon 3 jẹ́ shannon-3, shannon-3-pro, shannon-3.1 àti shannon-3.1-pro. Àwọn model àti iye owó

A gba àwọn field OpenAI mìíràn, bíi n, user, stream_options, parallel_tool_calls, presence_penalty, frequency_penalty, logit_bias, logprobs, metadata, store àti prompt_cache_key, kí code client tó wà tẹ́lẹ̀ lè ṣiṣẹ́ láìyípadà. Wọn kì í yí èsì padà: choice kan ni ó máa ń wà nígbà gbogbo, stream sì máa ń parí pẹ̀lú usage nígbà gbogbo.

Field tí irú JSON rẹ̀ kò tọ̀, fún àpẹẹrẹ "max_tokens": "100", yóò dá 422 padà. Ìbéèrè tí kò ní messages náà ń dá a padà.

Àwọn tool, structured output, ìrònú àti ìwá orí wẹ́ẹ̀bù ní ojú-ìwé tiwọn: Ipe iṣẹ, Awọn igbejade ti a ṣeto, Ipa ìrònú, Iwadi Wẹẹbu ti a ṣe sinu.

Ìbéèrè pẹ̀lú àwọn aṣayan

Ìbéèrè yìí ṣètò ìfiránṣẹ́ system, àwọn field sampling àti Ipa ìrònú. Ó lo model open-weight tí a gbàlejò, èyí tó ń lo gbogbo wọn.

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

Èsì náà ní ìrísí kan náà bí òkè. usage rẹ̀ ń fi ẹ̀kúnrẹ́rẹ́ méjì kún lórí àwọn model open-weight tí a gbàlejò: àwọn token prompt tí a kà láti inú cache àti àwọn token tí a lò lórí ìrònú.

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

Gígùn output

max_tokens ń ṣe nǹkan méjì. Àkọ́kọ́, ó jẹ́ iye token tí a fi pamọ́ láti inú balance rẹ nígbà tí ìbéèrè bẹ̀rẹ̀. Nígbà tí èsì bá parí, iye yẹn ni a ó fi àwọn token tí ìbéèrè náà lò rọ́pò. Tí max_tokens bá tóbi ju ohun tó kù nínú balance rẹ, ìbéèrè náà yóò dá 429 Quota exceeded padà bí èsì fúnra rẹ̀ bá tilẹ̀ wọ̀. Fi max_tokens tó kéré jù ránṣẹ́ láti fi pamọ́ díẹ̀.

A ń ka shannon-coder-1 lọ́nà míràn lórí endpoint yìí: ìbéèrè kọ̀ọ̀kan jẹ́ ọ̀kan nínú àwọn ìpè Shannon Coder ti plan rẹ, a kò sì fi token pamọ́ fún un. Àwọn ààlà àti balance

Èkejì, ó ń fi ààlà sí gígùn èsì lórí àwọn model wọ̀nyí:

Láìsí max_tokens tàbí max_completion_tokens, iye náà jẹ́ 4,096. Lórí shannon-coder-1 ó jẹ́ 65,536.

Àwọn ìfiránṣẹ́

Ìfiránṣẹ́ kọ̀ọ̀kan jẹ́ object pẹ̀lú role àti content. content jẹ́ string, tàbí array ti àwọn apá nígbà tí ìfiránṣẹ́ náà bá gbé ju ọ̀rọ̀ lọ.

Pẹ̀lú id ìdílé Shannon 3, fi àwọn ìtọ́ni tó gbọdọ̀ dúró sínú ìfiránṣẹ́ user.

Lórí àwọn ipele Shannon, ìbéèrè tí kò ní ọ̀rọ̀ user tàbí tools ń dá 400 No user message provided padà.

Àwọn apá àkóónú

Àwọn ìwọ̀n, ààlà àti àtòjọ kíkún ti àwọn ọ̀nà ní ojú-ìwé tiwọn. Àwọn àwòrán àti fáìlì

Object èsì

Àwọn ìdí ìparí

Èsì tí kì í ṣe streaming ń ròyìn stop tàbí tool_calls.

Ìlò

Lórí àwọn model open-weight tí a gbàlejò, prompt_tokens jẹ́ àwọn ìfiránṣẹ́ rẹ àti àwọn ìtumọ̀ tool tí a kà pẹ̀lú tokenizer ti model fúnra rẹ̀, pẹ̀lú àwọn token àwọn àwòrán èyíkéyìí. Àwọn endpoint ìkà token ń dá nọ́ńbà kan náà padà ṣáájú kí o tó fi ránṣẹ́. Kíka token

Lórí àwọn ipele Shannon, prompt_tokens ń ka gbogbo ohun tí model kà láti kọ èsì, nítorí náà ó tóbi ju ọ̀rọ̀ àwọn ìfiránṣẹ́ rẹ nìkan lọ.

Streaming

Pẹ̀lú stream tí a ṣètò sí true, èsì dé bí àwọn event chat.completion.chunk, ó sì parí pẹ̀lú data: [DONE]. Chunk tó gbẹ̀yìn ṣáájú rẹ̀ gbé finish_reason àti usage; a kò nílò stream_options. Ìrísí àwọn chunk, àwọn ìlà keep-alive àti àwọn àṣìṣe inú stream ní ojú-ìwé tiwọn. Sisanwọle

Àwọn àṣìṣe

Àṣìṣe jẹ́ JSON object tó ní member error. Àwọn àyẹ̀wò ń ṣiṣẹ́ ní ìtòlẹ́sẹẹsẹ yìí: API key, body ìbéèrè, id model, lẹ́yìn náà balance. Tábìlì náà ń kọ ohun tí endpoint yìí máa ń dá padà jùlọ. Àtòkọ kíkún, pẹ̀lú ohun tí a ó tún gbìyànjú, ní ojú-ìwé tirẹ̀. Mimu Aṣiṣe

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