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. Стовпець Застосовують називає моделі, на яких поле змінює відповідь. Хостовані open-weight моделі — це дванадцять 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, приймаються, щоб наявний клієнтський код працював без змін. Вони не змінюють відповідь: завжди є один варіант (choice), а стрім завжди завершується usage.

Поле з неправильним типом JSON, наприклад "max_tokens": "100", повертає 422. Запит без messages теж.

Інструменти, структурований вивід, міркування та веб-пошук мають власні сторінки: Виклик функцій, Структуровані відповіді, Зусилля міркування, Вбудований веб‑пошук.

Запит із параметрами

Цей запит задає системне повідомлення, поля семплювання та зусилля міркування. Він використовує хостовану open-weight модель, яка застосовує все це.

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 на хостованих open-weight моделях додає дві деталі: токени промпту, прочитані з кешу, та токени, витрачені на міркування.

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

Використання

На хостованих open-weight моделях 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"
  }
}