Chat Completions

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

Déi klengst Ufro ass eng Modell-ID an eng Benotzermessage.

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

D'Äntwert ass een JSON-Objet:

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

Ufro-Headers

Äntwert-Headers

Request-Felder

Nëmmen messages ass erfuerderlech. D'Kolonn Ugewannt vun nennt d'Modeller, bei deenen e Feld d'Äntwert ännert. D'Hosted Open-Weight-Modeller sinn déi zwielef IDen aus der Modellëscht; d'Shannon-3-Famill ass shannon-3, shannon-3-pro, shannon-3.1 an shannon-3.1-pro. Modeller a Präisser

Aner OpenAI-Felder, wéi n, user, stream_options, parallel_tool_calls, presence_penalty, frequency_penalty, logit_bias, logprobs, metadata, store an prompt_cache_key, ginn akzeptéiert, sou datt bestehende Client-Code onverännert leeft. Si änneren d'Äntwert net: et gëtt ëmmer eng Choice, an e Stream endet ëmmer mat Usage.

E Feld mam falsche JSON-Typ, zum Beispill "max_tokens": "100", gëtt 422 zréck. Eng Ufro ouni messages och.

Tools, strukturéierten Output, Reasoning a Websich hunn all hir eege Säit: Funktiounsofruff, Strukturéiert Output, Reasoning-Effort, Integréiert Websich.

Eng Ufro mat Optiounen

Dës Ufro setzt eng System-Message, d'Sampling-Felder an den Reasoning-Effort. Si benotzt en Hosted Open-Weight-Modell, dee se all applizéiert.

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

D'Äntwert huet déiselwecht Form wéi uewen. Hir usage füügt bei den Hosted Open-Weight-Modeller zwee Detailer derbäi: d'Prompt-Tokens, déi aus dem Cache gelies goufen, an d'Tokens, déi fir Reasoning ausgi goufen.

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

Output-Längt

max_tokens mécht zwou Saachen. Éischtens ass et d'Zuel vun den Tokens, déi vun Ärem Solde reservéiert ginn, wann d'Ufro ufänkt. Wann d'Äntwert komplett ass, gëtt dee Betrag duerch d'Tokens ersat, déi d'Ufro benotzt huet. Wann max_tokens méi grouss ass wéi dat, wat vun Ärem Solde iwwreg ass, gëtt d'Ufro 429 Quota exceeded zréck, och wann d'Äntwert selwer gepasst hätt. Schéckt e méi niddrege max_tokens, fir manner ze reservéieren.

shannon-coder-1 gëtt op dësem Endpoint anescht gezielt: all Ufro ass ee vun de Shannon-Coder-Ufruffer vun Ärem Plan, a fir si ginn keng Tokens reservéiert. Limiten a Solde

Zweetens begrenzt et d'Längt vun der Äntwert bei dëse Modeller:

Ouni max_tokens oder max_completion_tokens ass de Wäert 4,096. Bei shannon-coder-1 ass en 65,536.

Messagen

All Message ass en Objet mat enger role an engem content. content ass e String oder en Array vun Deeler, wann d'Message méi wéi Text dréit.

Bei enger ID aus der Shannon-3-Famill setzt Instruktioune, déi gëllen, an d'user-Message.

Bei de Shannon-Niveaue gëtt eng Ufro ouni Benotzertext a ouni tools 400 No user message provided zréck.

Content-Deeler

Gréissten, Limite an déi komplett Lëscht vun de Forme hunn hir eege Säit. Biller a Fichieren

Dat Äntwert-Objet

Finish-Reasons

Eng Äntwert, déi net gestreamt gëtt, mellt stop oder tool_calls.

Usage

Bei den Hosted Open-Weight-Modeller ass prompt_tokens Är Messagen an Tool-Definitiounen, gezielt mam eegenen Tokenizer vum Modell, plus d'Tokens vu Biller. D'Endpoints fir d'Token-Zielung ginn déiselwecht Zuel zréck, éier Dir schéckt. Tokenzielung

Bei de Shannon-Niveaue zielt prompt_tokens alles, wat de Modell gelies huet, fir d'Äntwert ze schreiwen, dofir ass et méi grouss wéi nëmmen den Text vun Ären Messagen.

Streaming

Wann stream op true gesat ass, kënnt d'Äntwert als chat.completion.chunk-Events a endet mat data: [DONE]. De leschte Chunk dovir dréit finish_reason an usage; stream_options sinn net néideg. D'Chunk-Forme, Keep-alive-Zeilen a Feeler an engem Stream hunn hir eege Säit. Streaming

Feeler

E Feeler ass en JSON-Objet mat engem error-Member. D'Kontrolle lafen an dëser Reiefolleg: API-Schlëssel, Ufro-Body, Modell-ID, dann Solde. D'Tabell lëscht, wat dësen Endpoint am heefegsten zréckgëtt. Déi komplett Lëscht, mat deem, wat Dir nei probéiere sollt, huet hir eege Säit. Feelerbehandlung

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