Chat Completions

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

Permintaan terkecil adalah id model dan satu pesan user.

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

Balasannya adalah 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

Field permintaan

Hanya messages yang wajib. Kolom Diterapkan oleh menyebutkan model tempat sebuah field mengubah balasan. Model open-weight hosted adalah dua belas id dalam daftar model; keluarga Shannon 3 adalah shannon-3, shannon-3-pro, shannon-3.1, dan shannon-3.1-pro. Model & harga

Field OpenAI lainnya, seperti n, user, stream_options, parallel_tool_calls, presence_penalty, frequency_penalty, logit_bias, logprobs, metadata, store, dan prompt_cache_key, diterima agar kode klien yang ada berjalan tanpa perubahan. Semuanya tidak mengubah balasan: selalu hanya ada satu choice, dan stream selalu diakhiri dengan usage.

Field dengan tipe JSON yang salah, misalnya "max_tokens": "100", mengembalikan 422. Permintaan tanpa messages juga demikian.

Tools, output terstruktur, reasoning, dan pencarian web masing-masing punya halaman sendiri: Pemanggilan fungsi, Output Terstruktur, Reasoning effort, Pencarian Web Terintegrasi.

Permintaan dengan opsi

Permintaan ini mengatur pesan system, field sampling, dan reasoning effort. Permintaan ini memakai model open-weight hosted, yang menerapkan semuanya.

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 berbentuk sama seperti di atas. usage-nya menambahkan dua rincian pada model open-weight hosted: token prompt yang dibaca dari cache dan token yang dipakai untuk reasoning.

{
  "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 hal. Pertama, itu adalah jumlah token yang dicadangkan dari saldo Anda saat permintaan dimulai. Ketika balasan selesai, jumlah itu diganti dengan token yang dipakai permintaan. Jika max_tokens lebih besar daripada sisa saldo Anda, permintaan mengembalikan 429 Quota exceeded meskipun balasannya sendiri sebenarnya muat. Kirim max_tokens yang lebih rendah untuk mencadangkan lebih sedikit.

shannon-coder-1 dihitung secara berbeda di endpoint ini: setiap permintaan adalah satu panggilan Shannon Coder dari paket Anda, dan tidak ada token yang dicadangkan untuknya. Batas dan saldo

Kedua, nilai ini membatasi panjang balasan pada model-model berikut:

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

Pesan

Setiap pesan adalah objek dengan role dan content. content berupa string, atau array bagian ketika pesan membawa lebih dari teks.

Dengan id keluarga Shannon 3, taruh instruksi yang harus dipatuhi ke dalam pesan user.

Pada tingkat Shannon, permintaan tanpa teks pengguna dan tanpa tools mengembalikan 400 No user message provided.

Bagian konten

Ukuran, batas, dan daftar lengkap bentuknya punya halaman sendiri. Gambar dan file

Objek balasan

Alasan selesai

Balasan tanpa streaming melaporkan stop atau tool_calls.

Penggunaan

Pada model open-weight hosted, prompt_tokens adalah pesan dan definisi tool Anda yang dihitung dengan tokenizer milik model itu, ditambah token dari gambar apa pun. Endpoint penghitungan token mengembalikan angka yang sama sebelum Anda mengirim. Penghitungan token

Pada tingkat Shannon, prompt_tokens menghitung semua yang dibaca model untuk menulis balasan, sehingga lebih besar daripada teks pesan Anda saja.

Streaming

Dengan stream diatur ke true, balasan tiba sebagai event chat.completion.chunk dan berakhir dengan data: [DONE]. Chunk terakhir sebelumnya membawa finish_reason dan usage; tidak diperlukan stream_options. Bentuk chunk, baris keep-alive, dan error di dalam stream punya halaman sendiri. Streaming

Error

Error adalah objek JSON dengan member error. Pemeriksaan berjalan dalam urutan ini: API key, body permintaan, id model, lalu saldo. Tabel mencantumkan apa yang paling sering dikembalikan endpoint ini. Daftar lengkap, beserta apa yang perlu dicoba ulang, ada di halaman tersendiri. Penanganan kesalahan

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