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 модели: токените на prompt-а, прочетени от кеша, и токените, изразходвани за разсъждение.

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

Usage

При хостваните open-weight модели prompt_tokens са вашите съобщения и дефиниции на инструменти, преброени с токенизатора на самия модел, плюс токените на евентуални изображения. Ендпоинтите за броене на токени връщат същото число, преди да изпратите. Броене на токени

При нивата на Shannon prompt_tokens брои всичко, което моделът е прочел, за да напише отговора, затова е по-голямо от текста само на вашите съобщения.

Стрийминг

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

Грешки

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

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