Chat Completions

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

De kleinste aanvraag bestaat uit een model-id en één gebruikersbericht.

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

Het antwoord is één JSON-object:

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

Headers

Request-headers

Antwoordheaders

Request-velden

Alleen messages is verplicht. De kolom Toegepast door noemt de modellen waarop een veld het antwoord verandert. De gehoste open-weight modellen zijn de twaalf id's uit de modellijst; de Shannon 3-familie is shannon-3, shannon-3-pro, shannon-3.1 en shannon-3.1-pro. Modellen en prijzen

Andere OpenAI-velden, zoals n, user, stream_options, parallel_tool_calls, presence_penalty, frequency_penalty, logit_bias, logprobs, metadata, store en prompt_cache_key, worden geaccepteerd zodat bestaande clientcode ongewijzigd draait. Ze veranderen het antwoord niet: er is altijd één choice, en een stream eindigt altijd met usage.

Een veld met het verkeerde JSON-type, bijvoorbeeld "max_tokens": "100", geeft 422 terug. Een aanvraag zonder messages ook.

Tools, gestructureerde output, reasoning en web search hebben elk een eigen pagina: Function calling, Gestructureerde outputs, Reasoning effort, Ingebouwde webzoekopdracht.

Een aanvraag met opties

Deze aanvraag stelt een systeembericht, de samplingvelden en de reasoning effort in. Ze gebruikt een gehost open-weight model, dat ze allemaal toepast.

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

Het antwoord heeft dezelfde vorm als hierboven. De usage ervan voegt op de gehoste open-weight modellen twee details toe: de prompttokens die uit de cache zijn gelezen en de tokens die aan reasoning zijn besteed.

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

Outputlengte

max_tokens doet twee dingen. Ten eerste is het het aantal tokens dat van je saldo wordt gereserveerd als de aanvraag begint. Zodra het antwoord compleet is, wordt dat bedrag vervangen door de tokens die de aanvraag heeft gebruikt. Als max_tokens groter is dan wat er van je saldo over is, geeft de aanvraag 429 Quota exceeded terug, ook als het antwoord zelf had gepast. Stuur een lagere max_tokens om minder te reserveren.

shannon-coder-1 wordt op dit endpoint anders geteld: elke aanvraag is een van de Shannon Coder-calls van je plan, en er worden geen tokens voor gereserveerd. Limieten en saldo

Ten tweede beperkt het de lengte van het antwoord op deze modellen:

Zonder max_tokens of max_completion_tokens is de waarde 4,096. Op shannon-coder-1 is dat 65,536.

Berichten

Elk bericht is een object met een role en een content. content is een string, of een array van onderdelen als het bericht meer dan tekst bevat.

Zet bij een id uit de Shannon 3-familie instructies die moeten gelden in het user-bericht.

Op de Shannon-tiers geeft een aanvraag zonder gebruikerstekst en zonder tools 400 No user message provided terug.

Contentonderdelen

Groottes, limieten en de volledige lijst met vormen hebben een eigen pagina. Afbeeldingen en bestanden

Het antwoordobject

Finish reasons

Een antwoord dat niet wordt gestreamd, meldt stop of tool_calls.

Usage

Op de gehoste open-weight modellen is prompt_tokens je berichten en tooldefinities geteld met de eigen tokenizer van het model, plus de tokens van eventuele afbeeldingen. De endpoints voor tokentelling geven hetzelfde getal terug voordat je verstuurt. Tokens tellen

Op de Shannon-tiers telt prompt_tokens alles wat het model heeft gelezen om het antwoord te schrijven, dus het is groter dan alleen de tekst van je berichten.

Streaming

Met stream op true komt het antwoord binnen als chat.completion.chunk-events en eindigt het met data: [DONE]. De laatste chunk daarvoor bevat finish_reason en usage; stream_options zijn niet nodig. De chunkvormen, keep-alive-regels en fouten binnen een stream hebben een eigen pagina. Streaming

Fouten

Een fout is een JSON-object met een error-lid. De controles verlopen in deze volgorde: API-sleutel, request-body, model-id en daarna saldo. De tabel toont wat dit endpoint het vaakst teruggeeft. De volledige lijst, met wat je opnieuw moet proberen, heeft een eigen pagina. Foutafhandeling

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