Chat Completions

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

Den minste forespørselen er en modell-id og én brukermelding.

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

Headere

Forespørsels-headere

Svar-headere

Forespørselsfelt

Bare messages er påkrevd. Kolonnen Brukes av nevner modellene der et felt endrer svaret. De hostede åpne vektmodellene er de tolv id-ene i modelllisten; Shannon 3-familien er shannon-3, shannon-3-pro, shannon-3.1 og shannon-3.1-pro. Modeller og priser

Andre OpenAI-felt, som n, user, stream_options, parallel_tool_calls, presence_penalty, frequency_penalty, logit_bias, logprobs, metadata, store og prompt_cache_key, godtas slik at eksisterende klientkode kjører uendret. De endrer ikke svaret: det er alltid ett valg, og en strøm avsluttes alltid med bruksdata.

Et felt med feil JSON-type, for eksempel "max_tokens": "100", gir 422. Det gjør også en forespørsel uten messages.

Verktøy, strukturert output, resonnering og nettsøk har hver sin side: Funksjonskall, Strukturerte utdata, Resonneringsinnsats, Innebygd websøk.

En forespørsel med valg

Denne forespørselen setter en systemmelding, samplingfeltene og resonneringsinnsatsen. Den bruker en hostet åpen vektmodell, som anvender alle disse.

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. usage får to detaljer til på de hostede åpne vektmodellene: prompt-tokens lest fra cachen og tokens brukt på resonnering.

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

Output-lengde

max_tokens gjør to ting. For det første er det antallet tokens som settes av fra saldoen din når forespørselen starter. Når svaret er fullført, erstattes beløpet av tokens forespørselen brukte. Hvis max_tokens er større enn det som er igjen av saldoen din, gir forespørselen 429 Quota exceeded selv om selve svaret ville ha passet. Send en lavere max_tokens for å sette av mindre.

shannon-coder-1 telles annerledes på dette endepunktet: hver forespørsel er ett av Shannon Coder-kallene i planen din, og ingen tokens settes av for den. Grenser og saldo

For det andre begrenser det lengden på svaret på disse modellene:

Uten max_tokens eller max_completion_tokens er verdien 4,096. På shannon-coder-1 er den 65,536.

Meldinger

Hver melding er et objekt med en role og et content. content er en streng, eller en matrise av deler når meldingen inneholder mer enn tekst.

Med en id fra Shannon 3-familien setter du instruksjoner som må gjelde, i user-meldingen.

På Shannon-nivåene gir en forespørsel uten brukertekst og uten tools 400 No user message provided.

Innholdsdeler

Størrelser, grenser og den fullstendige listen over former har sin egen side. Bilder og filer

Svarobjektet

Avslutningsårsaker

Et svar uten strømming rapporterer stop eller tool_calls.

Bruk

På de hostede åpne vektmodellene er prompt_tokens meldingene og verktøydefinisjonene dine talt med modellens egen tokenizer, pluss tokens for eventuelle bilder. Endepunktene for token-telling returnerer det samme tallet før du sender. Token-telling

På Shannon-nivåene teller prompt_tokens alt modellen leste for å skrive svaret, så tallet er større enn teksten i meldingene dine alene.

Strømming

Med stream satt til true kommer svaret som chat.completion.chunk-hendelser og avsluttes med data: [DONE]. Den siste chunken før den har finish_reason og usage; ingen stream_options trengs. Chunk-formene, keep-alive-linjene og feil inne i en strøm har sin egen side. Strømming

Feil

En feil er et JSON-objekt med et error-medlem. Sjekkene kjøres i denne rekkefølgen: API-nøkkel, forespørselskropp, modell-id, deretter saldo. Tabellen viser det dette endepunktet oftest returnerer. Den fullstendige listen, med hva som kan prøves på nytt, har sin egen side. Feilhåndtering

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