Chat Completions

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

Najmanjši zahtevek je id modela in eno uporabnikovo sporočilo.

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

Odgovor je en 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
  }
}

Glave

Glave zahtevka

Glave odgovora

Polja zahtevka

Zahtevano je samo messages. Stolpec Uporabljajo navaja modele, pri katerih polje spremeni odgovor. Gostovani modeli z odprtimi utežmi so dvanajst id-jev s seznama modelov; družina Shannon 3 so shannon-3, shannon-3-pro, shannon-3.1 in shannon-3.1-pro. Modeli in cene

Druga polja OpenAI, kot so n, user, stream_options, parallel_tool_calls, presence_penalty, frequency_penalty, logit_bias, logprobs, metadata, store in prompt_cache_key, so sprejeta, da obstoječa koda odjemalca deluje nespremenjena. Odgovora ne spremenijo: izbira je vedno ena, tok pa se vedno konča s porabo.

Polje z napačnim tipom JSON, na primer "max_tokens": "100", vrne 422. Enako velja za zahtevek brez messages.

Orodja, strukturiran izhod, razmišljanje in spletno iskanje imajo vsak svojo stran: Klicanje funkcij, Strukturirani izhodi, Napor razmišljanja, Vgrajeno spletno iskanje.

Zahtevek z možnostmi

Ta zahtevek nastavi sistemsko sporočilo, polja vzorčenja in napor razmišljanja. Uporablja gostovani model z odprtimi utežmi, ki upošteva vse našteto.

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

Odgovor ima enako obliko kot zgoraj. Njegov usage pri gostovanih modelih z odprtimi utežmi doda dve podrobnosti: tokene prompta, prebrane iz predpomnilnika, in tokene, porabljene za razmišljanje.

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

Dolžina izhoda

max_tokens naredi dvoje. Prvič, to je število tokenov, ki se ob začetku zahtevka odložijo z vašega stanja. Ko je odgovor končan, ta znesek nadomestijo tokeni, ki jih je zahtevek porabil. Če je max_tokens večji od tega, kar je ostalo na vašem stanju, zahtevek vrne 429 Quota exceeded, tudi če bi se odgovor sam še izšel. Pošljite manjši max_tokens, da odložite manj.

shannon-coder-1 se na tem endpointu šteje drugače: vsak zahtevek je eden od klicev Shannon Coder vašega paketa in zanj se ne odloži noben token. Omejitve in stanje

Drugič, omejuje dolžino odgovora na teh modelih:

Brez max_tokens ali max_completion_tokens je vrednost 4,096. Pri shannon-coder-1 je 65,536.

Sporočila

Vsako sporočilo je objekt z role in content. content je niz ali polje delov, kadar sporočilo nosi več kot besedilo.

Pri id-ju iz družine Shannon 3 navodila, ki morajo veljati, vstavite v sporočilo user.

Pri ravneh Shannon zahtevek brez besedila uporabnika in brez tools vrne 400 No user message provided.

Deli vsebine

Velikosti, omejitve in celoten seznam oblik imajo svojo stran. Slike in datoteke

Objekt odgovora

Razlogi za konec

Odgovor, ki ni pretočen, sporoča stop ali tool_calls.

Poraba

Pri gostovanih modelih z odprtimi utežmi so prompt_tokens vaša sporočila in definicije orodij, prešteti z modelovim lastnim tokenizerjem, plus tokeni morebitnih slik. Endpointa za štetje tokenov vrneta isto število, preden pošljete. Štetje tokenov

Pri ravneh Shannon prompt_tokens šteje vse, kar je model prebral, da je napisal odgovor, zato je večje od besedila samih vaših sporočil.

Pretakanje

Ko je stream nastavljen na true, odgovor prihaja kot dogodki chat.completion.chunk in se konča z data: [DONE]. Zadnji kos pred tem nosi finish_reason in usage; stream_options ni treba. Oblike kosov, vrstice keep-alive in napake znotraj toka imajo svojo stran. Pretakanje

Napake

Napaka je objekt JSON s članom error. Preverjanja potekajo v tem vrstnem redu: API ključ, telo zahtevka, id modela, nato stanje. Tabela navaja, kaj ta endpoint najpogosteje vrne. Celoten seznam s priporočili, kaj ponoviti, ima svojo stran. Obravnava napak

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