Chat Completions

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

Die kleinste Anfrage besteht aus einer Modell-ID und einer User-Nachricht.

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

Die Antwort ist ein 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
  }
}

Header

Anfrage-Header

Antwort-Header

Anfragefelder

Nur messages ist erforderlich. Die Spalte Angewendet von nennt die Modelle, bei denen ein Feld die Antwort verändert. Die gehosteten Open-Weight-Modelle sind die zwölf IDs der Modellliste; die Shannon-3-Familie besteht aus shannon-3, shannon-3-pro, shannon-3.1 und shannon-3.1-pro. Modelle & Preise

Weitere OpenAI-Felder wie n, user, stream_options, parallel_tool_calls, presence_penalty, frequency_penalty, logit_bias, logprobs, metadata, store und prompt_cache_key werden akzeptiert, damit vorhandener Client-Code unverändert läuft. Sie verändern die Antwort nicht: Es gibt immer genau eine Choice, und ein Stream endet immer mit Nutzungsdaten.

Ein Feld mit dem falschen JSON-Typ, zum Beispiel "max_tokens": "100", gibt 422 zurück. Eine Anfrage ohne messages ebenfalls.

Tools, strukturierte Ausgabe, Reasoning und Websuche haben jeweils eine eigene Seite: Funktionsaufrufe, Strukturierte Ausgaben, Reasoning-Aufwand, Integrierte Websuche.

Eine Anfrage mit Optionen

Diese Anfrage setzt eine System-Nachricht, die Sampling-Felder und den Reasoning-Aufwand. Sie verwendet ein gehostetes Open-Weight-Modell, das alle davon anwendet.

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

Die Antwort hat dieselbe Form wie oben. Ihre usage ergänzt bei den gehosteten Open-Weight-Modellen zwei Details: die aus dem Cache gelesenen Prompt-Tokens und die für Reasoning aufgewendeten Tokens.

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

Output-Länge

max_tokens bewirkt zwei Dinge. Erstens ist es die Anzahl der Tokens, die beim Start der Anfrage von Ihrem Guthaben zurückgelegt werden. Ist die Antwort vollständig, wird dieser Betrag durch die Tokens ersetzt, die die Anfrage verbraucht hat. Ist max_tokens größer als das, was von Ihrem Guthaben übrig ist, gibt die Anfrage 429 Quota exceeded zurück, auch wenn die Antwort selbst gepasst hätte. Senden Sie ein niedrigeres max_tokens, um weniger zurückzulegen.

shannon-coder-1 wird bei diesem Endpunkt anders gezählt: Jede Anfrage ist einer der Shannon-Coder-Aufrufe Ihres Plans, und dafür werden keine Tokens zurückgelegt. Limits und Guthaben

Zweitens begrenzt es bei diesen Modellen die Länge der Antwort:

Ohne max_tokens oder max_completion_tokens beträgt der Wert 4,096. Bei shannon-coder-1 sind es 65,536.

Nachrichten

Jede Nachricht ist ein Objekt mit einer role und einem content. content ist ein String oder ein Array von Teilen, wenn die Nachricht mehr als Text enthält.

Bei einer ID der Shannon-3-Familie gehören Anweisungen, die gelten müssen, in die user-Nachricht.

Bei den Shannon-Stufen gibt eine Anfrage ohne Nutzertext und ohne tools 400 No user message provided zurück.

Content-Teile

Größen, Limits und die vollständige Liste der Formen haben eine eigene Seite. Bilder und Dateien

Das Antwortobjekt

Finish-Gründe

Eine Antwort, die nicht gestreamt wird, meldet stop oder tool_calls.

Nutzung

Bei den gehosteten Open-Weight-Modellen sind prompt_tokens Ihre Nachrichten und Tool-Definitionen, gezählt mit dem eigenen Tokenizer des Modells, plus die Tokens eventueller Bilder. Die Endpunkte zum Token-Zählen liefern dieselbe Zahl, bevor Sie senden. Token zählen

Bei den Shannon-Stufen zählt prompt_tokens alles, was das Modell gelesen hat, um die Antwort zu schreiben, und ist daher größer als allein der Text Ihrer Nachrichten.

Streaming

Ist stream auf true gesetzt, trifft die Antwort als chat.completion.chunk-Events ein und endet mit data: [DONE]. Der letzte Chunk davor enthält finish_reason und usage; stream_options sind nicht nötig. Die Chunk-Formen, Keep-alive-Zeilen und Fehler innerhalb eines Streams haben eine eigene Seite. Streaming

Fehler

Ein Fehler ist ein JSON-Objekt mit einem Member error. Die Prüfungen laufen in dieser Reihenfolge: API-Key, Request-Body, Modell-ID, dann Guthaben. Die Tabelle listet, was dieser Endpunkt am häufigsten zurückgibt. Die vollständige Liste, mit Hinweisen, was wiederholt werden sollte, hat eine eigene Seite. Fehlerbehandlung

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