Chat Completions

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

Cea mai mică cerere este un id de model și un mesaj de utilizator.

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

Răspunsul este un singur obiect 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
  }
}

Header-e

Header-e de cerere

Header-e de răspuns

Câmpuri de cerere

Doar messages este obligatoriu. Coloana Aplicat de indică modelele pe care un câmp modifică răspunsul. Modelele open-weight găzduite sunt cele douăsprezece id-uri din lista de modele; familia Shannon 3 este shannon-3, shannon-3-pro, shannon-3.1 și shannon-3.1-pro. Modele și prețuri

Alte câmpuri OpenAI, precum n, user, stream_options, parallel_tool_calls, presence_penalty, frequency_penalty, logit_bias, logprobs, metadata, store și prompt_cache_key, sunt acceptate astfel încât codul client existent să ruleze neschimbat. Ele nu modifică răspunsul: există întotdeauna o singură alegere (choice), iar un stream se încheie întotdeauna cu utilizarea.

Un câmp cu tipul JSON greșit, de exemplu "max_tokens": "100", returnează 422. La fel și o cerere fără messages.

Instrumentele, ieșirea structurată, raționamentul și căutarea web au fiecare propria pagină: Apelare funcții, Rezultate structurate, Efort de raționament, Căutare web integrată.

O cerere cu opțiuni

Această cerere setează un mesaj de sistem, câmpurile de eșantionare și efortul de raționament. Folosește un model open-weight găzduit, care le aplică pe toate.

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

Răspunsul are aceeași formă ca mai sus. usage adaugă două detalii pe modelele open-weight găzduite: token-urile de prompt citite din cache și token-urile consumate pentru raționament.

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

Lungimea ieșirii

max_tokens face două lucruri. În primul rând, este numărul de token-uri rezervat din soldul tău la începutul cererii. Când răspunsul este complet, această sumă este înlocuită cu token-urile folosite de cerere. Dacă max_tokens este mai mare decât ce a rămas din soldul tău, cererea returnează 429 Quota exceeded chiar dacă răspunsul în sine ar fi încăput. Trimite un max_tokens mai mic pentru a rezerva mai puțin.

shannon-coder-1 este numărat diferit pe acest endpoint: fiecare cerere este unul dintre apelurile Shannon Coder ale planului tău și nu se rezervă token-uri pentru ea. Limite și sold

În al doilea rând, limitează lungimea răspunsului pe aceste modele:

Fără max_tokens sau max_completion_tokens, valoarea este 4,096. Pe shannon-coder-1 este 65,536.

Mesaje

Fiecare mesaj este un obiect cu un role și un content. content este un șir de caractere sau o matrice de părți atunci când mesajul conține mai mult decât text.

Cu un id din familia Shannon 3, pune instrucțiunile care trebuie respectate în mesajul user.

Pe nivelurile Shannon, o cerere fără text de la utilizator și fără tools returnează 400 No user message provided.

Părți de conținut

Dimensiunile, limitele și lista completă a formelor au propria pagină. Imagini și fișiere

Obiectul răspuns

Motive de încheiere

Un răspuns fără streaming raportează stop sau tool_calls.

Utilizare

Pe modelele open-weight găzduite, prompt_tokens reprezintă mesajele și definițiile tale de instrumente, numărate cu tokenizatorul propriu al modelului, plus token-urile imaginilor, dacă există. Endpoint-urile de numărare a token-urilor returnează același număr înainte să trimiți cererea. Numărarea token-urilor

Pe nivelurile Shannon, prompt_tokens numără tot ce a citit modelul pentru a scrie răspunsul, deci este mai mare decât textul mesajelor tale luat singur.

Streaming

Cu stream setat la true, răspunsul sosește ca evenimente chat.completion.chunk și se încheie cu data: [DONE]. Ultimul chunk dinaintea lui poartă finish_reason și usage; nu este nevoie de stream_options. Formele chunk-urilor, liniile keep-alive și erorile din interiorul unui stream au propria pagină. Streaming

Erori

O eroare este un obiect JSON cu un membru error. Verificările rulează în această ordine: cheia API, corpul cererii, id-ul modelului, apoi soldul. Tabelul listează ce returnează cel mai des acest endpoint. Lista completă, cu ce merită reîncercat, are propria pagină. Gestionare erori

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