Chat Completions

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

A legkisebb kérés egy modellazonosító és egy felhasználói üzenet.

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

A válasz egyetlen JSON-objektum:

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

Fejlécek

Kérésfejlécek

Válaszfejlécek

Kérésmezők

Csak a messages kötelező. Az Alkalmazza oszlop megnevezi azokat a modelleket, amelyeken a mező megváltoztatja a választ. A hosztolt nyílt súlyú modellek a modelllista tizenkét azonosítója; a Shannon 3 család a shannon-3, shannon-3-pro, shannon-3.1 és shannon-3.1-pro. Modellek és árak

Más OpenAI-mezők, például az n, user, stream_options, parallel_tool_calls, presence_penalty, frequency_penalty, logit_bias, logprobs, metadata, store és prompt_cache_key elfogadottak, hogy a meglévő klienskód változtatás nélkül fusson. Nem változtatják meg a választ: mindig egyetlen choice van, és a stream mindig használati adattal végződik.

A hibás JSON-típusú mező, például "max_tokens": "100", 422 hibát ad. A messages nélküli kérés is.

Az eszközöknek, a strukturált kimenetnek, a reasoningnak és a webes keresésnek külön oldaluk van: Funkcióhívás, Strukturált kimenetek, Reasoning effort, Beépített webes keresés.

Egy kérés opciókkal

Ez a kérés rendszerüzenetet, mintavételi mezőket és reasoning effortot állít be. Hosztolt nyílt súlyú modellt használ, amely mindet alkalmazza.

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

A válasz alakja ugyanaz, mint fent. A hosztolt nyílt súlyú modelleken a usage két részlettel bővül: a gyorsítótárból olvasott prompt-tokenekkel és a reasoningra költött tokenekkel.

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

Kimenet hossza

A max_tokens két dolgot tesz. Először: ennyi tokent foglal le az egyenlegedből a kérés indulásakor. Ha a válasz kész, ezt a mennyiséget a kérés által ténylegesen használt tokenek váltják fel. Ha a max_tokens nagyobb, mint az egyenlegedből megmaradt rész, a kérés 429 Quota exceeded hibát ad, még akkor is, ha maga a válasz elfért volna. Kevesebb lefoglalásához küldj kisebb max_tokens értéket.

A shannon-coder-1 ezen a végponton másképp számít: minden kérés a csomagod egy Shannon Coder hívása, és nem foglalnak le hozzá tokent. Korlátok és egyenleg

Másodszor: ezeken a modelleken korlátozza a válasz hosszát:

max_tokens vagy max_completion_tokens nélkül az érték 4,096. A shannon-coder-1 modellen 65,536.

Üzenetek

Minden üzenet egy objektum role és content mezővel. A content egy string, vagy részek tömbje, ha az üzenet nem csak szöveget hordoz.

Shannon 3 családbeli azonosítónál a feltétlenül betartandó utasításokat tedd a user üzenetbe.

A Shannon szinteken a felhasználói szöveg és tools nélküli kérés 400 No user message provided hibát ad.

Tartalomrészek

A méreteknek, korlátoknak és az alakok teljes listájának külön oldala van. Képek és fájlok

A válaszobjektum

Befejezési okok

A nem streamelt válasz stop vagy tool_calls értéket jelez.

Használat

A hosztolt nyílt súlyú modelleken a prompt_tokens az üzeneteid és eszközdefiníciód a modell saját tokenizerével számolva, plusz az esetleges képek tokenjei. A tokenszámláló végpontok küldés előtt ugyanezt a számot adják vissza. Tokenszámlálás

A Shannon szinteken a prompt_tokens mindent számol, amit a modell a válasz megírásához elolvasott, ezért nagyobb, mint az üzeneteid szövege egyedül.

Streaming

A stream true értékével a válasz chat.completion.chunk eseményekként érkezik, és data: [DONE] sorral ér véget. Az előtte lévő utolsó chunk tartalmazza a finish_reason és a usage értékét; stream_options nem szükséges. A chunkok alakjának, a keep-alive soroknak és a streamen belüli hibáknak külön oldaluk van. Streaming

Hibák

A hiba egy JSON-objektum error taggal. Az ellenőrzések ebben a sorrendben futnak: API-kulcs, kérés törzse, modellazonosító, majd egyenleg. A táblázat azt sorolja fel, amit ez a végpont leggyakrabban visszaad. A teljes listának, azzal együtt, hogy mit érdemes újrapróbálni, külön oldala van. Hibakezelés

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