Chat Completions

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

Nejmenší požadavek je id modelu a jedna zpráva uživatele.

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

Odpověď je jeden objekt 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
  }
}

Hlavičky

Hlavičky požadavku

Hlavičky odpovědi

Pole požadavku

Povinné je pouze messages. Sloupec Uplatňují uvádí modely, u nichž pole mění odpověď. Hostované modely s otevřenými váhami je dvanáct id ze seznamu modelů; rodina Shannon 3 je shannon-3, shannon-3-pro, shannon-3.1 a shannon-3.1-pro. Modely a ceny

Další pole OpenAI, například n, user, stream_options, parallel_tool_calls, presence_penalty, frequency_penalty, logit_bias, logprobs, metadata, store a prompt_cache_key, se přijímají, aby stávající klientský kód běžel beze změny. Odpověď neovlivňují: vždy existuje jedna volba a stream vždy končí využitím.

Pole se špatným typem JSON, například "max_tokens": "100", vrátí 422. Stejně tak požadavek bez messages.

Nástroje, strukturovaný výstup, uvažování a vyhledávání na webu mají každé vlastní stránku: Volání funkcí, Strukturované výstupy, Úsilí uvažování, Vestavěné webové vyhledávání.

Požadavek s volbami

Tento požadavek nastavuje zprávu system, pole vzorkování a úsilí uvažování. Používá hostovaný model s otevřenými váhami, který uplatní všechny.

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

Odpověď má stejný tvar jako výše. Její usage u hostovaných modelů s otevřenými váhami přidává dva údaje: prompt tokeny přečtené z cache a tokeny spotřebované na uvažování.

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

Délka výstupu

max_tokens dělá dvě věci. Za prvé je to počet tokenů, které se vašemu zůstatku vyhradí při zahájení požadavku. Po dokončení odpovědi se tato částka nahradí tokeny, které požadavek skutečně spotřeboval. Pokud je max_tokens větší, než kolik zbývá z vašeho zůstatku, požadavek vrátí 429 Quota exceeded, i když by se samotná odpověď vešla. Pošlete nižší max_tokens, aby se vyhradilo méně.

shannon-coder-1 se na tomto endpointu počítá jinak: každý požadavek je jedno z volání Shannon Coder vašeho plánu a nevyhrazují se pro něj žádné tokeny. Limity a zůstatek

Za druhé omezuje délku odpovědi u těchto modelů:

Bez max_tokens nebo max_completion_tokens je hodnota 4,096. U shannon-coder-1 je 65,536.

Zprávy

Každá zpráva je objekt s role a content. content je řetězec, nebo pole částí, když zpráva nese víc než text.

U id z rodiny Shannon 3 dejte instrukce, které musí platit, do zprávy user.

Na úrovních Shannon vrátí požadavek bez uživatelského textu a bez tools 400 No user message provided.

Části obsahu

Velikosti, limity a úplný seznam forem mají vlastní stránku. Obrázky a soubory

Objekt odpovědi

Důvody ukončení

Odpověď, která není streamovaná, hlásí stop nebo tool_calls.

Využití

U hostovaných modelů s otevřenými váhami jsou prompt_tokens vaše zprávy a definice nástrojů spočítané vlastním tokenizérem modelu plus tokeny případných obrázků. Endpointy pro počítání tokenů vrací stejné číslo dřív, než odešlete. Počítání tokenů

Na úrovních Shannon prompt_tokens počítá všechno, co model přečetl, aby napsal odpověď, takže je větší než samotný text vašich zpráv.

Streamování

S stream nastaveným na true odpověď přichází jako události chat.completion.chunk a končí data: [DONE]. Poslední chunk před ním nese finish_reason a usage; stream_options nejsou potřeba. Tvary chunků, keep-alive řádky a chyby uvnitř streamu mají vlastní stránku. Streamování

Chyby

Chyba je objekt JSON se členem error. Kontroly probíhají v tomto pořadí: API klíč, tělo požadavku, id modelu, pak zůstatek. Tabulka uvádí, co tento endpoint vrací nejčastěji. Úplný seznam, včetně toho, co opakovat, má vlastní stránku. Zpracování chyb

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