Chat Completions

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

La sol·licitud més petita és un id de model i un missatge d'usuari.

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

La resposta és un sol objecte JSON:

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

Capçaleres

Capçaleres de la sol·licitud

Capçaleres de la resposta

Camps de la sol·licitud

Només messages és obligatori. La columna S'aplica a indica els models en què un camp canvia la resposta. Els models open-weight hostejats són els dotze ids de la llista de models; la família Shannon 3 és shannon-3, shannon-3-pro, shannon-3.1 i shannon-3.1-pro. Models i preus

Altres camps d'OpenAI, com n, user, stream_options, parallel_tool_calls, presence_penalty, frequency_penalty, logit_bias, logprobs, metadata, store i prompt_cache_key, s'accepten perquè el codi de client existent funcioni sense canvis. No canvien la resposta: sempre hi ha una sola opció, i un stream sempre acaba amb l'ús.

Un camp amb un tipus JSON incorrecte, per exemple "max_tokens": "100", retorna 422. Una sol·licitud sense messages també.

Les eines, la sortida estructurada, el raonament i la cerca web tenen cadascun la seva pròpia pàgina: Crida de funcions, Sortides estructurades, Esforç de raonament, Cerca web.

Una sol·licitud amb opcions

Aquesta sol·licitud defineix un missatge de sistema, els camps de mostreig i l'esforç de raonament. Fa servir un model open-weight hostejat, que els aplica tots.

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

La resposta té la mateixa forma que dalt. El seu usage afegeix dos detalls als models open-weight hostejats: els tokens de prompt llegits de la cache i els tokens gastats en raonament.

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

Longitud de la sortida

max_tokens fa dues coses. Primer, és el nombre de tokens que es reserven del teu saldo quan comença la sol·licitud. Quan la resposta és completa, aquesta quantitat se substitueix pels tokens que la sol·licitud ha fet servir. Si max_tokens és més gran que el que queda del teu saldo, la sol·licitud retorna 429 Quota exceeded encara que la resposta mateixa hauria cabut. Envia un max_tokens més baix per reservar-ne menys.

shannon-coder-1 es compta de manera diferent en aquest endpoint: cada sol·licitud és una de les crides de Shannon Coder del teu pla, i no es reserva cap token per a ella. Límits i saldo

Segon, limita la longitud de la resposta en aquests models:

Sense max_tokens ni max_completion_tokens, el valor és 4,096. A shannon-coder-1 és 65,536.

Missatges

Cada missatge és un objecte amb un role i un content. content és una cadena o una matriu de parts quan el missatge porta més que text.

Amb un id de la família Shannon 3, posa les instruccions que s'han de complir al missatge user.

Als nivells Shannon, una sol·licitud sense text d'usuari ni tools retorna 400 No user message provided.

Parts del contingut

Les mides, els límits i la llista completa de formes tenen la seva pròpia pàgina. Imatges i fitxers

L'objecte de resposta

Motius de finalització

Una resposta sense stream informa stop o tool_calls.

Ús

Als models open-weight hostejats, prompt_tokens són els teus missatges i definicions d'eines comptats amb el tokenitzador del mateix model, més els tokens de les imatges. Els endpoints de recompte de tokens retornen el mateix número abans que enviïs. Recompte de tokens

Als nivells Shannon, prompt_tokens compta tot el que el model ha llegit per escriure la resposta, de manera que és més gran que el text dels teus missatges sol.

Streaming

Amb stream definit a true, la resposta arriba com a esdeveniments chat.completion.chunk i acaba amb data: [DONE]. L'últim fragment abans porta finish_reason i usage; no calen stream_options. Les formes dels fragments, les línies keep-alive i els errors dins d'un stream tenen la seva pròpia pàgina. Streaming

Errors

Un error és un objecte JSON amb un membre error. Les comprovacions s'executen en aquest ordre: clau API, cos de la sol·licitud, id del model i després saldo. La taula llista el que aquest endpoint retorna més sovint. La llista completa, amb què cal tornar a provar, té la seva pròpia pàgina. Gestió d’errors

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