Chat Completions

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

Den mindste anmodning er et model-id og én brugerbesked.

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 er ét 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

Anmodningsheaders

Svarheaders

Anmodningsfelter

Kun messages er påkrævet. Kolonnen Anvendes af angiver de modeller, hvor et felt ændrer svaret. De hostede open-weight-modeller er de tolv id'er på modellisten; Shannon 3-familien er shannon-3, shannon-3-pro, shannon-3.1 og shannon-3.1-pro. Modeller og priser

Andre OpenAI-felter, f.eks. n, user, stream_options, parallel_tool_calls, presence_penalty, frequency_penalty, logit_bias, logprobs, metadata, store og prompt_cache_key, accepteres, så eksisterende klientkode kører uændret. De ændrer ikke svaret: der er altid ét valg, og en stream slutter altid med forbrug.

Et felt med den forkerte JSON-type, f.eks. "max_tokens": "100", returnerer 422. Det gør en anmodning uden messages også.

Værktøjer, struktureret output, reasoning og websøgning har hver deres egen side: Funktionskald, Strukturerede outputs, Reasoning effort, Indbygget websøgning.

En anmodning med indstillinger

Denne anmodning angiver en systembesked, samplingfelterne og reasoning effort. Den bruger en hostet open-weight-model, som anvender dem alle.

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 samme form som ovenfor. Dets usage tilføjer to detaljer på de hostede open-weight-modeller: de prompt-tokens, der er læst fra cachen, og de tokens, der er brugt på reasoning.

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

Outputlængde

max_tokens gør to ting. For det første er det det antal tokens, der reserveres fra din saldo, når anmodningen starter. Når svaret er færdigt, erstattes det beløb af de tokens, anmodningen brugte. Hvis max_tokens er større end det, der er tilbage af din saldo, returnerer anmodningen 429 Quota exceeded, selv om selve svaret ville have passet. Send en lavere max_tokens for at reservere mindre.

shannon-coder-1 tælles anderledes på dette endpoint: hver anmodning er ét af din plans Shannon Coder-kald, og der reserveres ingen tokens til den. Grænser og saldo

For det andet begrænser det svarets længde på disse modeller:

Uden max_tokens eller max_completion_tokens er værdien 4,096. På shannon-coder-1 er den 65,536.

Beskeder

Hver besked er et objekt med en role og et content. content er en streng eller et array af dele, når beskeden indeholder mere end tekst.

Med et id fra Shannon 3-familien skal du lægge instruktioner, der skal overholdes, i user-beskeden.

På Shannon-niveauerne returnerer en anmodning uden brugertekst og uden tools 400 No user message provided.

Indholdsdele

Størrelser, grænser og den fulde liste over former har deres egen side. Billeder og filer

Svarobjektet

Afslutningsårsager

Et svar, der ikke streames, rapporterer stop eller tool_calls.

Forbrug

På de hostede open-weight-modeller er prompt_tokens dine beskeder og værktøjsdefinitioner talt med modellens egen tokenizer plus tokens fra eventuelle billeder. Endpointene til tokentælling returnerer det samme tal, før du sender. Tælling af tokens

På Shannon-niveauerne tæller prompt_tokens alt, modellen læste for at skrive svaret, så tallet er større end teksten i dine beskeder alene.

Streaming

Når stream er sat til true, kommer svaret som chat.completion.chunk-hændelser og slutter med data: [DONE]. Den sidste chunk før den indeholder finish_reason og usage; der er ikke brug for nogen stream_options. Chunk-formerne, keep-alive-linjerne og fejl inde i en stream har deres egen side. Streaming

Fejl

En fejl er et JSON-objekt med et error-medlem. Kontrollerne køres i denne rækkefølge: API-nøgle, anmodningens body, model-id og til sidst saldo. Tabellen viser, hvad dette endpoint oftest returnerer. Den fulde liste med, hvad der kan prøves igen, har sin egen side. Fejlhåndtering

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