Chat Completions

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

Permintaan terkecil ialah id model dan satu mesej pengguna.

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

Balasan ialah satu objek 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

Header permintaan

Header balasan

Medan permintaan

Hanya messages yang diperlukan. Lajur Dilaksanakan oleh menamakan model yang balasannya diubah oleh sesuatu medan. Model open-weight yang dihoskan ialah dua belas id dalam senarai model; keluarga Shannon 3 ialah shannon-3, shannon-3-pro, shannon-3.1 dan shannon-3.1-pro. Model & harga

Medan OpenAI yang lain, seperti n, user, stream_options, parallel_tool_calls, presence_penalty, frequency_penalty, logit_bias, logprobs, metadata, store dan prompt_cache_key, diterima supaya kod klien sedia ada berjalan tanpa perubahan. Ia tidak mengubah balasan: sentiasa ada satu choice, dan stream sentiasa berakhir dengan penggunaan.

Medan dengan jenis JSON yang salah, contohnya "max_tokens": "100", memulangkan 422. Permintaan tanpa messages juga begitu.

Alat, output berstruktur, penaakulan dan carian web masing-masing mempunyai halaman tersendiri: Panggilan Fungsi, Output Berstruktur, Usaha penaakulan, Carian Web Terbina dalam.

Permintaan dengan pilihan

Permintaan ini menetapkan mesej sistem, medan persampelan dan tahap usaha penaakulan. Ia menggunakan model open-weight yang dihoskan, yang melaksanakan kesemuanya.

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

Balasan mempunyai bentuk yang sama seperti di atas. usagenya menambah dua butiran pada model open-weight yang dihoskan: token prompt yang dibaca daripada cache dan token yang dibelanjakan untuk penaakulan.

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

Panjang output

max_tokens melakukan dua perkara. Pertama, ia ialah bilangan token yang diketepikan daripada baki anda apabila permintaan bermula. Apabila balasan selesai, jumlah itu digantikan dengan token yang digunakan oleh permintaan. Jika max_tokens lebih besar daripada baki anda yang tinggal, permintaan memulangkan 429 Quota exceeded walaupun balasan itu sendiri akan muat. Hantar max_tokens yang lebih rendah untuk mengetepikan lebih sedikit.

shannon-coder-1 dikira secara berbeza pada endpoint ini: setiap permintaan ialah satu daripada panggilan Shannon Coder pelan anda, dan tiada token diketepikan untuknya. Had dan baki

Kedua, ia mengehadkan panjang balasan pada model ini:

Tanpa max_tokens atau max_completion_tokens, nilainya ialah 4,096. Pada shannon-coder-1 ia ialah 65,536.

Mesej

Setiap mesej ialah objek dengan role dan content. content ialah rentetan, atau tatasusunan bahagian apabila mesej membawa lebih daripada teks.

Dengan id keluarga Shannon 3, letakkan arahan yang mesti dipatuhi dalam mesej user.

Pada peringkat Shannon, permintaan tanpa teks pengguna dan tanpa tools memulangkan 400 No user message provided.

Bahagian kandungan

Saiz, had dan senarai penuh bentuk mempunyai halaman tersendiri. Imej dan fail

Objek balasan

Sebab selesai

Balasan yang bukan stream melaporkan stop atau tool_calls.

Penggunaan

Pada model open-weight yang dihoskan, prompt_tokens ialah mesej dan takrifan alat anda yang dikira dengan tokenizer model itu sendiri, ditambah token mana-mana imej. Endpoint pengiraan token memulangkan nombor yang sama sebelum anda menghantar. Pengiraan token

Pada peringkat Shannon, prompt_tokens mengira segala yang dibaca oleh model untuk menulis balasan, jadi ia lebih besar daripada teks mesej anda sahaja.

Streaming

Dengan stream ditetapkan kepada true, balasan tiba sebagai peristiwa chat.completion.chunk dan berakhir dengan data: [DONE]. Ketulan terakhir sebelumnya membawa finish_reason dan usage; tiada stream_options diperlukan. Bentuk ketulan, baris keep-alive dan ralat di dalam stream mempunyai halaman tersendiri. Penstriman

Ralat

Ralat ialah objek JSON dengan ahli error. Semakan berjalan mengikut urutan ini: kunci API, badan permintaan, id model, kemudian baki. Jadual menyenaraikan apa yang paling kerap dipulangkan oleh endpoint ini. Senarai penuh, beserta apa yang perlu dicuba semula, mempunyai halaman tersendiri. Pengendalian Ralat

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