Chat Completions

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

Најмалото барање е ид на модел и една корисничка порака.

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 модели се дванаесетте ид-а од листата на модели; семејството 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, а streaming секогаш завршува со употреба.

Поле со погрешен JSON тип, на пример "max_tokens": "100", враќа 422. Исто и барање без messages.

Алатките, структурираниот излез, reasoning-от и веб пребарувањето имаат секој своја страница: Повик на функции, Структурирани излези, Напор на reasoning, Вградено веб пребарување.

Барање со опции

Ова барање поставува порака system, полиња за семплирање и напор на reasoning. Користи хостиран 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 токените прочитани од кешот и токените потрошени на reasoning.

{
  "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 на овој endpoint се брои поинаку: секое барање е еден од повиците на Shannon Coder од вашиот план, а за него не се одвојуваат токени. Ограничувања и салдо

Второ, ја ограничува должината на одговорот на овие модели:

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

Пораки

Секоја порака е објект со role и content. content е стринг или низа од делови кога пораката носи повеќе од текст.

Со ид од семејството Shannon 3, ставете ги упатствата што мора да важат во пораката user.

На нивоата на Shannon барање без кориснички текст и без tools враќа 400 No user message provided.

Делови на содржина

Големините, лимитите и целосната листа на облици имаат своја страница. Слики и датотеки

Објектот на одговорот

Причини за завршување

Одговор без streaming пријавува stop или tool_calls.

Употреба

На хостираните open-weight модели, prompt_tokens се вашите пораки и дефиниции на алатки избројани со сопствениот токенизатор на моделот, плус токените на сликите. Endpoint-ите за броење токени го враќаат истиот број пред да испратите. Броење токени

На нивоата на Shannon, prompt_tokens брои сè што моделот го прочитал за да го напише одговорот, па е поголем од самиот текст на вашите пораки.

Streaming

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

Грешки

Грешката е JSON објект со член error. Проверките се извршуваат по овој редослед: API клуч, тело на барање, ид на модел, па салдо. Табелата го наведува она што овој endpoint најчесто го враќа. Целосната листа, со тоа што да се повтори, има своја страница. Ракување со грешки

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