Chat Completions

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

Den minsta begäran är ett modell-id och ett användarmeddelande.

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

Svaret är ett 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
  }
}

Headers

Begäransheaders

Svarsheaders

Begäranfält

Endast messages är obligatoriskt. Kolumnen Tillämpas av anger de modeller där ett fält ändrar svaret. De hostade open-weight-modellerna är de tolv id:n i modellistan; Shannon 3-familjen är shannon-3, shannon-3-pro, shannon-3.1 och shannon-3.1-pro. Modeller och priser

Andra OpenAI-fält, som n, user, stream_options, parallel_tool_calls, presence_penalty, frequency_penalty, logit_bias, logprobs, metadata, store och prompt_cache_key, accepteras så att befintlig klientkod körs oförändrad. De ändrar inte svaret: det finns alltid ett val (choice), och en ström slutar alltid med usage.

Ett fält med fel JSON-typ, till exempel "max_tokens": "100", ger 422. Det gör även en begäran utan messages.

Verktyg, strukturerad utdata, resonemang och webbsökning har var sin sida: Funktionsanrop, Strukturerade utdata, Resonemangsansträngning, Inbyggd webbsökning.

En begäran med alternativ

Den här begäran anger ett systemmeddelande, samplingsfälten och resonemangsansträngningen. Den använder en hostad open-weight-modell, som tillämpar alla dessa.

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

Svaret har samma form som ovan. Dess usage lägger till två uppgifter på de hostade open-weight-modellerna: de prompttokens som lästs från cachen och de tokens som gått åt till resonemang.

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

Outputlängd

max_tokens gör två saker. För det första är det antalet tokens som reserveras från din balans när begäran startar. När svaret är klart ersätts det beloppet av de tokens som begäran förbrukade. Om max_tokens är större än vad som återstår av din balans ger begäran 429 Quota exceeded även om själva svaret hade fått plats. Skicka ett lägre max_tokens för att reservera mindre.

shannon-coder-1 räknas annorlunda på den här endpointen: varje begäran är ett av din plans Shannon Coder-anrop, och inga tokens reserveras för den. Gränser och balans

För det andra begränsar det svarets längd på de här modellerna:

Utan max_tokens eller max_completion_tokens är värdet 4,096. På shannon-coder-1 är det 65,536.

Meddelanden

Varje meddelande är ett objekt med en role och ett content. content är en sträng, eller en array av delar när meddelandet innehåller mer än text.

Med ett id i Shannon 3-familjen ska instruktioner som måste gälla läggas i user-meddelandet.

På Shannon-nivåerna ger en begäran utan användartext och utan tools 400 No user message provided.

Innehållsdelar

Storlekar, gränser och den fullständiga listan över former har en egen sida. Bilder och filer

Svarsobjektet

Avslutsorsaker

Ett svar som inte streamas rapporterar stop eller tool_calls.

Användning

På de hostade open-weight-modellerna är prompt_tokens dina meddelanden och verktygsdefinitioner räknade med modellens egen tokenizer, plus tokens för eventuella bilder. Endpointsen för tokenräkning returnerar samma tal innan du skickar. Tokenräkning

På Shannon-nivåerna räknar prompt_tokens allt som modellen läste för att skriva svaret, så det är större än enbart texten i dina meddelanden.

Streaming

Med stream satt till true kommer svaret som chat.completion.chunk-händelser och slutar med data: [DONE]. Sista chunken före den bär finish_reason och usage; inga stream_options behövs. Chunkformerna, keep-alive-raderna och felen inuti en ström har en egen sida. Streaming

Fel

Ett fel är ett JSON-objekt med en error-medlem. Kontrollerna körs i den här ordningen: API-nyckel, begäranskropp, modell-id, därefter balans. Tabellen listar det som den här endpointen oftast returnerar. Den fullständiga listan, med vad som ska försökas igen, har en egen sida. Felhantering

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