Chat Completions

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

La solicitud más pequeña es un id de modelo y un mensaje 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."}]
  }'

La respuesta es un único objeto 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
  }
}

Headers

Headers de la solicitud

Headers de la respuesta

Campos de solicitud

Solo messages es obligatorio. La columna Aplicado por indica los modelos en los que un campo cambia la respuesta. Los modelos de pesos abiertos alojados son los doce ids de la lista de modelos; la familia Shannon 3 es shannon-3, shannon-3-pro, shannon-3.1 y shannon-3.1-pro. Modelos y precios

Se aceptan otros campos de OpenAI, como n, user, stream_options, parallel_tool_calls, presence_penalty, frequency_penalty, logit_bias, logprobs, metadata, store y prompt_cache_key, para que el código de cliente existente funcione sin cambios. No modifican la respuesta: siempre hay una sola choice, y un stream siempre termina con el uso.

Un campo con un tipo JSON incorrecto, por ejemplo "max_tokens": "100", devuelve 422. Una solicitud sin messages también.

Las herramientas, la salida estructurada, el razonamiento y la búsqueda web tienen cada uno su propia página: Llamadas a funciones, Salidas estructuradas, Esfuerzo de razonamiento, Búsqueda web integrada.

Una solicitud con opciones

Esta solicitud establece un mensaje de sistema, los campos de muestreo y el esfuerzo de razonamiento. Usa un modelo de pesos abiertos alojado, que aplica todos ellos.

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 respuesta tiene la misma forma que la anterior. Su usage añade dos detalles en los modelos de pesos abiertos alojados: los tokens del prompt leídos de la caché y los tokens gastados en razonamiento.

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

Longitud de salida

max_tokens hace dos cosas. Primero, es el número de tokens que se reservan de tu saldo cuando empieza la solicitud. Cuando la respuesta está completa, esa cantidad se sustituye por los tokens que usó la solicitud. Si max_tokens es mayor que lo que queda de tu saldo, la solicitud devuelve 429 Quota exceeded aunque la respuesta en sí hubiera cabido. Envía un max_tokens menor para reservar menos.

shannon-coder-1 se cuenta de forma distinta en este endpoint: cada solicitud es una de las llamadas de Shannon Coder de tu plan, y no se reservan tokens para ella. Límites y saldo

Segundo, limita la longitud de la respuesta en estos modelos:

Sin max_tokens ni max_completion_tokens, el valor es 4,096. En shannon-coder-1 es 65,536.

Mensajes

Cada mensaje es un objeto con un role y un content. content es una cadena o un array de partes cuando el mensaje lleva algo más que texto.

Con un id de la familia Shannon 3, pon las instrucciones que deben cumplirse en el mensaje user.

En los niveles de Shannon, una solicitud sin texto de usuario ni tools devuelve 400 No user message provided.

Partes de contenido

Los tamaños, los límites y la lista completa de formas tienen su propia página. Imágenes y archivos

El objeto de respuesta

Motivos de finalización

Una respuesta sin streaming informa stop o tool_calls.

Uso

En los modelos de pesos abiertos alojados, prompt_tokens son tus mensajes y definiciones de herramientas contados con el tokenizador propio del modelo, más los tokens de las imágenes. Los endpoints de conteo de tokens devuelven el mismo número antes de que envíes. Conteo de tokens

En los niveles de Shannon, prompt_tokens cuenta todo lo que el modelo leyó para escribir la respuesta, por lo que es mayor que el texto de tus mensajes por sí solo.

Streaming

Con stream en true, la respuesta llega como eventos chat.completion.chunk y termina con data: [DONE]. El último fragmento antes de este lleva finish_reason y usage; no hacen falta stream_options. Las formas de los fragmentos, las líneas de keep-alive y los errores dentro de un stream tienen su propia página. Streaming

Errores

Un error es un objeto JSON con un miembro error. Las comprobaciones se ejecutan en este orden: clave API, cuerpo de la solicitud, id del modelo y después saldo. La tabla muestra lo que este endpoint devuelve con más frecuencia. La lista completa, con qué reintentar, tiene su propia página. Manejo de errores

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