Chat Completions

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

Минимальный запрос — это id модели и одно сообщение пользователя.

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

Ответ — один 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
  }
}

Заголовки

Заголовки запроса

Заголовки ответа

Поля запроса

Обязательно только messages. В столбце Применяется на указаны модели, на которых поле влияет на ответ. Размещенные модели с открытыми весами — это двенадцать id из списка моделей; семейство Shannon 3 — это shannon-3, shannon-3-pro, shannon-3.1 и shannon-3.1-pro. Модели и цены

Другие поля OpenAI, такие как n, user, stream_options, parallel_tool_calls, presence_penalty, frequency_penalty, logit_bias, logprobs, metadata, store и prompt_cache_key, принимаются, чтобы существующий клиентский код работал без изменений. Они не меняют ответ: вариант ответа всегда один, а поток всегда заканчивается usage.

Поле с неверным типом JSON, например "max_tokens": "100", возвращает 422. Запрос без messages тоже.

Инструменты, структурированный вывод, рассуждения и веб-поиск описаны каждый на своей странице: Вызов функций, Структурированные ответы, Усилие рассуждения, Встроенный веб‑поиск.

Запрос с параметрами

Этот запрос задает системное сообщение, поля сэмплирования и усилие рассуждения. Он использует размещенную модель с открытыми весами, которая применяет все эти параметры.

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

Ответ имеет ту же форму, что и выше. Его usage на размещенных моделях с открытыми весами добавляет две детали: токены промпта, прочитанные из кэша, и токены, потраченные на рассуждения.

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

Длина вывода

max_tokens делает две вещи. Во-первых, это число токенов, которое резервируется на вашем балансе в начале запроса. Когда ответ завершен, эта сумма заменяется токенами, которые запрос фактически использовал. Если max_tokens больше остатка вашего баланса, запрос возвращает 429 Quota exceeded, даже если сам ответ поместился бы. Отправьте меньший max_tokens, чтобы зарезервировать меньше.

shannon-coder-1 на этом эндпоинте считается иначе: каждый запрос — это один из вызовов Shannon Coder по вашему плану, и токены под него не резервируются. Лимиты и баланс

Во-вторых, он ограничивает длину ответа на этих моделях:

Без max_tokens или max_completion_tokens значение равно 4,096. На shannon-coder-1 оно равно 65,536.

Сообщения

Каждое сообщение — это объект с role и content. content — строка или массив частей, когда сообщение содержит не только текст.

С id семейства Shannon 3 помещайте обязательные инструкции в сообщение user.

На уровнях Shannon запрос без пользовательского текста и без tools возвращает 400 No user message provided.

Части контента

Размеры, лимиты и полный список форм описаны на отдельной странице. Изображения и файлы

Объект ответа

Причины завершения

Ответ без стриминга сообщает stop или tool_calls.

Использование

На размещенных моделях с открытыми весами prompt_tokens — это ваши сообщения и определения инструментов, подсчитанные собственным токенайзером модели, плюс токены изображений. Эндпоинты подсчета токенов возвращают то же число до отправки. Подсчет токенов

На уровнях Shannon prompt_tokens учитывает все, что модель прочитала, чтобы написать ответ, поэтому оно больше, чем один только текст ваших сообщений.

Стриминг

Если stream равен true, ответ приходит событиями chat.completion.chunk и заканчивается data: [DONE]. Последний чанк перед ним содержит finish_reason и usage; stream_options не нужны. Формы чанков, keep-alive-строки и ошибки внутри потока описаны на отдельной странице. Потоковая передача

Ошибки

Ошибка — это JSON-объект с полем error. Проверки выполняются в таком порядке: API-ключ, тело запроса, id модели, затем баланс. В таблице перечислено то, что этот эндпоинт возвращает чаще всего. Полный список с указанием, что повторять, находится на отдельной странице. Обработка ошибок

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