Chat Completions

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

Najmniejsze zapytanie to id modelu i jedna wiadomość użytkownika.

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

Odpowiedzią jest jeden obiekt 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
  }
}

Nagłówki

Nagłówki zapytania

Nagłówki odpowiedzi

Pola zapytania

Wymagane jest tylko messages. Kolumna Stosowane przez podaje modele, w których pole zmienia odpowiedź. Hostowane modele open-weight to dwanaście id z listy modeli; rodzina Shannon 3 to shannon-3, shannon-3-pro, shannon-3.1 i shannon-3.1-pro. Modele i ceny

Inne pola OpenAI, takie jak n, user, stream_options, parallel_tool_calls, presence_penalty, frequency_penalty, logit_bias, logprobs, metadata, store i prompt_cache_key, są akceptowane, aby istniejący kod klienta działał bez zmian. Nie zmieniają odpowiedzi: zawsze jest jeden wybór (choice), a strumień zawsze kończy się użyciem.

Pole ze złym typem JSON, na przykład "max_tokens": "100", zwraca 422. Zapytanie bez messages także.

Narzędzia, wyjście strukturyzowane, wnioskowanie i wyszukiwanie w sieci mają każde własną stronę: Wywołanie funkcji, Ustrukturyzowane odpowiedzi, Wysiłek rozumowania, Wbudowane wyszukiwanie w sieci.

Zapytanie z opcjami

To zapytanie ustawia wiadomość systemową, pola próbkowania i wysiłek rozumowania. Używa hostowanego modelu open-weight, który stosuje je wszystkie.

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

Odpowiedź ma ten sam kształt co powyżej. Jej usage dodaje w hostowanych modelach open-weight dwie pozycje: tokeny promptu odczytane z cache i tokeny wydane na wnioskowanie.

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

Długość wyjścia

max_tokens robi dwie rzeczy. Po pierwsze, jest liczbą tokenów odłożoną z Twojego salda na początku zapytania. Gdy odpowiedź jest kompletna, ta kwota jest zastępowana tokenami, które zapytanie zużyło. Jeśli max_tokens jest większe niż to, co zostało z Twojego salda, zapytanie zwraca 429 Quota exceeded, nawet gdyby sama odpowiedź się zmieściła. Wyślij niższe max_tokens, aby odłożyć mniej.

shannon-coder-1 jest w tym endpoincie liczony inaczej: każde zapytanie to jedno z wywołań Shannon Coder w Twoim planie i żadne tokeny nie są na nie odkładane. Limity i saldo

Po drugie, ogranicza długość odpowiedzi w tych modelach:

Bez max_tokens i max_completion_tokens wartość wynosi 4,096. W shannon-coder-1 jest to 65,536.

Wiadomości

Każda wiadomość to obiekt z role i content. content to ciąg znaków albo tablica części, gdy wiadomość niesie coś więcej niż tekst.

Przy id z rodziny Shannon 3 umieść instrukcje, które muszą obowiązywać, w wiadomości user.

W poziomach Shannon zapytanie bez tekstu użytkownika i bez tools zwraca 400 No user message provided.

Części treści

Rozmiary, limity i pełna lista form mają własną stronę. Obrazy i pliki

Obiekt odpowiedzi

Powody zakończenia

Odpowiedź bez streamingu raportuje stop lub tool_calls.

Użycie

W hostowanych modelach open-weight prompt_tokens to Twoje wiadomości i definicje narzędzi policzone własnym tokenizerem modelu, plus tokeny wszystkich obrazów. Endpointy liczenia tokenów zwracają tę samą liczbę, zanim wyślesz zapytanie. Liczenie tokenów

W poziomach Shannon prompt_tokens liczy wszystko, co model przeczytał, by napisać odpowiedź, więc jest większe niż sam tekst Twoich wiadomości.

Streaming

Gdy stream ma wartość true, odpowiedź przychodzi jako zdarzenia chat.completion.chunk i kończy się data: [DONE]. Ostatni fragment przed nim niesie finish_reason i usage; stream_options nie są potrzebne. Kształty fragmentów, linie keep-alive i błędy wewnątrz strumienia mają własną stronę. Streaming

Błędy

Błąd to obiekt JSON z polem error. Kontrole przebiegają w tej kolejności: klucz API, treść zapytania, id modelu, a potem saldo. Tabela pokazuje, co ten endpoint zwraca najczęściej. Pełna lista, razem z informacją, co ponawiać, ma własną stronę. Obsługa błędów

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