Chat Completions

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

Najmenší request je id modelu a jedna správa používateľa.

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

Odpoveď 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 requestu

Hlavičky odpovede

Polia requestu

Povinné je iba messages. Stĺpec Uplatňuje uvádza modely, na ktorých pole mení odpoveď. Hostované open-weight modely sú dvanásť id zo zoznamu modelov; rodinu Shannon 3 tvoria shannon-3, shannon-3-pro, shannon-3.1 a shannon-3.1-pro. Modely a ceny

Ďalšie polia OpenAI, ako n, user, stream_options, parallel_tool_calls, presence_penalty, frequency_penalty, logit_bias, logprobs, metadata, store a prompt_cache_key, sa prijímajú, aby existujúci klientsky kód bežal bez zmien. Odpoveď nemenia: vždy je len jedna voľba a stream vždy končí usage.

Pole s nesprávnym typom JSON, napríklad "max_tokens": "100", vráti 422. Rovnako aj request bez messages.

Nástroje, štruktúrovaný výstup, uvažovanie a webové vyhľadávanie majú každé vlastnú stránku: Volanie funkcií, Štruktúrované výstupy, Úsilie pri uvažovaní, Vstavané webové vyhľadávanie.

Request s voľbami

Tento request nastavuje systémovú správu, polia vzorkovania a úsilie pri uvažovaní. Používa hostovaný open-weight model, ktorý uplatní všetky.

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

Odpoveď má rovnaký tvar ako vyššie. Jej usage pridáva na hostovaných open-weight modeloch dva detaily: tokeny promptu prečítané z cache a tokeny minuté na uvažovanie.

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

Dĺžka výstupu

max_tokens robí dve veci. Po prvé, je to počet tokenov vyhradený zo zostatku, keď request začne. Po dokončení odpovede sa táto suma nahradí tokenmi, ktoré request použil. Ak je max_tokens väčšie, než koľko zostáva z vášho zostatku, request vráti 429 Quota exceeded, aj keby sa samotná odpoveď zmestila. Pošlite nižšie max_tokens, aby sa vyhradilo menej.

shannon-coder-1 sa na tomto endpointe počíta inak: každý request je jedno z volaní Shannon Coder vášho plánu a nevyhradzujú sa naň žiadne tokeny. Limity a zostatok

Po druhé, obmedzuje dĺžku odpovede na týchto modeloch:

Bez max_tokens alebo max_completion_tokens je hodnota 4,096. Na shannon-coder-1 je 65,536.

Správy

Každá správa je objekt s role a content. content je reťazec alebo pole častí, keď správa nesie viac než text.

S id z rodiny Shannon 3 dajte pokyny, ktoré musia platiť, do správy user.

Na úrovniach Shannon vráti request bez textu používateľa a bez tools 400 No user message provided.

Časti obsahu

Veľkosti, limity a úplný zoznam foriem majú vlastnú stránku. Obrázky a súbory

Objekt odpovede

Dôvody ukončenia

Odpoveď, ktorá sa nestreamuje, hlási stop alebo tool_calls.

Usage

Na hostovaných open-weight modeloch sú prompt_tokens vaše správy a definície nástrojov spočítané vlastným tokenizerom modelu plus tokeny prípadných obrázkov. Endpointy na počítanie tokenov vrátia rovnaké číslo ešte pred odoslaním. Počítanie tokenov

Na úrovniach Shannon prompt_tokens počíta všetko, čo model prečítal na napísanie odpovede, takže je väčšie než samotný text vašich správ.

Streamovanie

S stream nastaveným na true odpoveď prichádza ako udalosti chat.completion.chunk a končí data: [DONE]. Posledný chunk pred ním nesie finish_reason a usage; stream_options netreba. Tvary chunkov, keep-alive riadky a chyby vnútri streamu majú vlastnú stránku. Streamovanie

Chyby

Chyba je objekt JSON s členom error. Kontroly bežia v tomto poradí: API kľúč, telo requestu, id modelu, potom zostatok. Tabuľka uvádza, čo tento endpoint vracia najčastejšie. Úplný zoznam s odporúčaním, čo opakovať, má vlastnú stránku. Spracovanie chýb

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