Chat Completions

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

Najmanji zahtjev je id modela i jedna korisnička poruka.

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 jedan JSON objekt:

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

Zaglavlja

Zaglavlja zahtjeva

Zaglavlja odgovora

Polja zahtjeva

Obavezan je samo messages. Stupac Primjenjuju navodi modele na kojima polje mijenja odgovor. Hostirani open-weight modeli su dvanaest id-ova s popisa modela; obitelj Shannon 3 su shannon-3, shannon-3-pro, shannon-3.1 i shannon-3.1-pro. Modeli i cijene

Ostala OpenAI polja, kao što su n, user, stream_options, parallel_tool_calls, presence_penalty, frequency_penalty, logit_bias, logprobs, metadata, store i prompt_cache_key, prihvaćaju se kako bi postojeći klijentski kod radio nepromijenjen. Ne mijenjaju odgovor: uvijek postoji jedan izbor, a stream uvijek završava upotrebom.

Polje s pogrešnim JSON tipom, na primjer "max_tokens": "100", vraća 422. Isto vrijedi za zahtjev bez messages.

Alati, strukturirani izlaz, rezoniranje i web pretraga imaju svaki svoju stranicu: Pozivanje funkcija, Strukturirani izlazi, Razina napora rezoniranja, Ugrađena web pretraga.

Zahtjev s opcijama

Ovaj zahtjev postavlja system poruku, polja uzorkovanja i razinu napora rezoniranja. Koristi hostirani open-weight model, koji primjenjuje sve njih.

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 isti oblik kao gore. Njegov usage na hostiranim open-weight modelima dodaje dva detalja: tokene prompta pročitane iz cachea i tokene potrošene na rezoniranje.

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

Duljina izlaza

max_tokens radi dvije stvari. Prvo, to je broj tokena koji se odvaja sa stanja kada zahtjev počne. Kada je odgovor gotov, taj iznos zamjenjuju tokeni koje je zahtjev iskoristio. Ako je max_tokens veći od onoga što je preostalo na stanju, zahtjev vraća 429 Quota exceeded čak i kada bi se sam odgovor stao. Pošaljite manji max_tokens da odvojite manje.

shannon-coder-1 se na ovom endpointu broji drukčije: svaki zahtjev je jedan od Shannon Coder poziva vašeg plana i za njega se ne odvajaju tokeni. Ograničenja i stanje

Drugo, ograničava duljinu odgovora na ovim modelima:

Bez max_tokens ili max_completion_tokens vrijednost je 4,096. Na shannon-coder-1 je 65,536.

Poruke

Svaka poruka je objekt s role i content. content je string ili niz dijelova kada poruka nosi više od teksta.

S id-om iz obitelji Shannon 3 upute koje moraju vrijediti stavite u poruku user.

Na Shannon razinama zahtjev bez korisničkog teksta i bez tools vraća 400 No user message provided.

Dijelovi sadržaja

Veličine, ograničenja i potpun popis oblika imaju vlastitu stranicu. Slike i datoteke

Objekt odgovora

Razlozi završetka

Odgovor bez streama prijavljuje stop ili tool_calls.

Upotreba

Na hostiranim open-weight modelima prompt_tokens su vaše poruke i definicije alata izbrojene tokenizerom samog modela, plus tokeni svih slika. Endpointi za brojanje tokena vraćaju isti broj prije nego pošaljete. Brojanje tokena

Na Shannon razinama prompt_tokens broji sve što je model pročitao da bi napisao odgovor, pa je veći od samog teksta vaših poruka.

Streaming

Kada je stream postavljen na true, odgovor stiže kao chat.completion.chunk događaji i završava s data: [DONE]. Zadnji chunk prije toga nosi finish_reason i usage; stream_options nisu potrebni. Oblici chunkova, keep-alive retci i greške unutar streama imaju vlastitu stranicu. Streaming

Greške

Greška je JSON objekt s članom error. Provjere se izvršavaju ovim redom: API ključ, tijelo zahtjeva, id modela, zatim stanje. Tablica navodi što ovaj endpoint najčešće vraća. Potpuni popis, s uputom što ponoviti, ima vlastitu stranicu. Upravljanje greškama

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