Chat Completions

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

Pienin pyyntö on mallin id ja yksi käyttäjän viesti.

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

Vastaus on yksi JSON-objekti:

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

Otsakkeet

Pyynnön otsakkeet

Vastauksen otsakkeet

Pyynnön kentät

Vain messages on pakollinen. Käyttävät mallit -sarake nimeää mallit, joilla kenttä muuttaa vastausta. Hostatut avoimen painon mallit ovat mallilistan kaksitoista id:tä; Shannon 3 -perhe on shannon-3, shannon-3-pro, shannon-3.1 ja shannon-3.1-pro. Mallit ja hinnoittelu

Muut OpenAI-kentät, kuten n, user, stream_options, parallel_tool_calls, presence_penalty, frequency_penalty, logit_bias, logprobs, metadata, store ja prompt_cache_key, hyväksytään, jotta olemassa oleva asiakaskoodi toimii muuttumattomana. Ne eivät muuta vastausta: vaihtoehtoja on aina yksi, ja virta päättyy aina käyttötietoihin.

Kenttä, jonka JSON-tyyppi on väärä, esimerkiksi "max_tokens": "100", palauttaa 422. Samoin pyyntö ilman messages-kenttää.

Työkaluilla, strukturoidulla tulosteella, päättelyllä ja verkkohaulla on kullakin oma sivunsa: Toiminto kutsu, Strukturoidut lähdöt, Päättelyn teho, Sisäänrakennettu verkkohaku.

Pyyntö asetuksineen

Tämä pyyntö asettaa system-viestin, näytteenottokentät ja päättelyn tehon. Se käyttää hostattua avoimen painon mallia, joka soveltaa niitä kaikkia.

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

Vastauksella on sama muoto kuin yllä. Sen usage lisää hostatuilla avoimen painon malleilla kaksi tietoa: välimuistista luetut prompt-tokenit ja päättelyyn käytetyt tokenit.

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

Tulosteen pituus

max_tokens tekee kaksi asiaa. Ensinnäkin se on tokenien määrä, joka varataan saldostasi pyynnön alussa. Kun vastaus on valmis, tämä määrä korvataan pyynnön käyttämillä tokeneilla. Jos max_tokens on suurempi kuin saldostasi jäljellä oleva määrä, pyyntö palauttaa 429 Quota exceeded, vaikka vastaus itsessään olisi mahtunut. Lähetä pienempi max_tokens, jos haluat varata vähemmän.

shannon-coder-1 lasketaan tässä päätepisteessä eri tavalla: jokainen pyyntö on yksi tilauksesi Shannon Coder -kutsuista, eikä sille varata tokeneita. Rajat ja saldo

Toiseksi se rajoittaa vastauksen pituutta näillä malleilla:

Ilman max_tokens- tai max_completion_tokens-kenttää arvo on 4,096. Mallilla shannon-coder-1 se on 65,536.

Viestit

Jokainen viesti on objekti, jolla on role ja content. content on merkkijono tai osien taulukko, kun viesti sisältää muutakin kuin tekstiä.

Shannon 3 -perheen id:llä pakollisesti noudatettavat ohjeet kuuluvat user-viestiin.

Shannon-tasoilla pyyntö ilman käyttäjän tekstiä ja ilman tools-kenttää palauttaa 400 No user message provided.

Sisältöosat

Koot, rajat ja muotojen täydellinen lista on kuvattu omalla sivullaan. Kuvat ja tiedostot

Vastausobjekti

Päättymissyyt

Suoratoistamaton vastaus raportoi arvon stop tai tool_calls.

Käyttö

Hostatuilla avoimen painon malleilla prompt_tokens on viestiesi ja työkalumääritystesi koko mallin oman tokenisoijan laskemana sekä mahdollisten kuvien tokenit. Tokenien laskennan päätepisteet palauttavat saman luvun ennen lähettämistä. Tokenien laskenta

Shannon-tasoilla prompt_tokens laskee kaiken, minkä malli luki vastauksen kirjoittamiseksi, joten se on suurempi kuin pelkkä viestiesi teksti.

Suoratoisto

Kun stream on true, vastaus saapuu chat.completion.chunk-tapahtumina ja päättyy data: [DONE]. Sitä edeltävä viimeinen pala kuljettaa kentät finish_reason ja usage; stream_options-kenttiä ei tarvita. Palojen muodot, keep-alive-rivit ja virran sisäiset virheet on kuvattu omalla sivullaan. Suoratoisto

Virheet

Virhe on JSON-objekti, jossa on error-jäsen. Tarkistukset tehdään tässä järjestyksessä: API-avain, pyynnön runko, mallin id, sitten saldo. Taulukossa on yleisimmin palautuvat virheet tästä päätepisteestä. Täydellinen lista ja ohjeet uudelleenyritykseen ovat omalla sivullaan. Virheiden käsittely

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