Chat Completions

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

A solicitude máis pequena é un id de modelo e unha mensaxe de usuario.

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

A resposta é un obxecto 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
  }
}

Cabeceiras

Cabeceiras da solicitude

Cabeceiras da resposta

Campos da solicitude

Só messages é obrigatorio. A columna Aplicado por indica os modelos nos que un campo cambia a resposta. Os modelos open-weight alojados son os doce ids da lista de modelos; a familia Shannon 3 é shannon-3, shannon-3-pro, shannon-3.1 e shannon-3.1-pro. Modelos e prezos

Acéptanse outros campos de OpenAI, como n, user, stream_options, parallel_tool_calls, presence_penalty, frequency_penalty, logit_bias, logprobs, metadata, store e prompt_cache_key, para que o código de cliente existente funcione sen cambios. Non alteran a resposta: sempre hai unha soa opción (choice) e un stream remata sempre co uso.

Un campo co tipo JSON incorrecto, por exemplo "max_tokens": "100", devolve 422. Unha solicitude sen messages tamén.

As ferramentas, a saída estruturada, o razoamento e a busca web teñen cada un a súa propia páxina: Chamadas a funcións, Saídas estruturadas, Esforzo de razoamento, Busca web.

Unha solicitude con opcións

Esta solicitude define unha mensaxe de sistema, os campos de mostraxe e o esforzo de razoamento. Usa un modelo open-weight alojado, que aplica todos eles.

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

A resposta ten a mesma forma que a anterior. O seu usage engade dous detalles nos modelos open-weight alojados: os tokens de prompt lidos da caché e os tokens gastados en razoamento.

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

Lonxitude da saída

max_tokens fai dúas cousas. Primeiro, é o número de tokens que se reservan do teu saldo cando comeza a solicitude. Cando a resposta está completa, esa cantidade substitúese polos tokens que usou a solicitude. Se max_tokens é maior que o que queda do teu saldo, a solicitude devolve 429 Quota exceeded aínda que a resposta en si tería cabido. Envía un max_tokens menor para reservar menos.

shannon-coder-1 cóntase de forma diferente neste endpoint: cada solicitude é unha das chamadas de Shannon Coder do teu plan, e non se reserva ningún token para ela. Límites e saldo

Segundo, limita a lonxitude da resposta nestes modelos:

Sen max_tokens nin max_completion_tokens, o valor é 4,096. En shannon-coder-1 é 65,536.

Mensaxes

Cada mensaxe é un obxecto cun role e un content. content é unha cadea ou unha matriz de partes cando a mensaxe leva algo máis que texto.

Cun id da familia Shannon 3, pon na mensaxe user as instrucións que deban cumprirse.

Nos niveis Shannon, unha solicitude sen texto de usuario nin tools devolve 400 No user message provided.

Partes de contido

Os tamaños, os límites e a lista completa de formas teñen a súa propia páxina. Imaxes e ficheiros

O obxecto de resposta

Motivos de finalización

Unha resposta sen stream informa stop ou tool_calls.

Uso

Nos modelos open-weight alojados, prompt_tokens son as túas mensaxes e definicións de ferramentas contadas co tokenizador propio do modelo, máis os tokens das imaxes. Os endpoints de reconto de tokens devolven o mesmo número antes de que envíes. Reconto de tokens

Nos niveis Shannon, prompt_tokens conta todo o que leu o modelo para escribir a resposta, así que é maior que o texto das túas mensaxes só.

Streaming

Con stream definido como true, a resposta chega como eventos chat.completion.chunk e remata con data: [DONE]. O último chunk antes del leva finish_reason e usage; non fan falta stream_options. As formas dos chunks, as liñas keep-alive e os erros dentro dun stream teñen a súa propia páxina. Streaming

Erros

Un erro é un obxecto JSON cun membro error. As comprobacións execútanse nesta orde: clave API, corpo da solicitude, id do modelo e despois saldo. A táboa mostra o que este endpoint devolve con máis frecuencia. A lista completa, con indicacións sobre que reintentar, ten a súa propia páxina. Xestión de erros

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