Chat Completions

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

คำขอที่เล็กที่สุดคือ model id และข้อความของผู้ใช้หนึ่งข้อความ

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 ที่โฮสต์คือ id ทั้งสิบสองตัวในรายการโมเดล ส่วนตระกูล 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 เดียวเสมอ และสตรีมจะจบด้วย usage เสมอ

ฟิลด์ที่มีชนิด JSON ผิด เช่น "max_tokens": "100" จะคืน 422 คำขอที่ไม่มี messages ก็เช่นกัน

Tools, เอาต์พุตแบบมีโครงสร้าง, การให้เหตุผล และการค้นหาเว็บ ต่างมีหน้าของตัวเอง: การเรียกฟังก์ชัน, เอาต์พุตแบบมีโครงสร้าง, ระดับความพยายามในการให้เหตุผล, ค้นหาเว็บในตัว.

คำขอที่มีตัวเลือก

คำขอนี้กำหนดข้อความ system, ฟิลด์ sampling และระดับความพยายามในการให้เหตุผล โดยใช้โมเดล 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 tokens ที่อ่านจากแคช และ tokens ที่ใช้ไปกับการให้เหตุผล

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

ความยาวเอาต์พุต

max_tokens ทำสองอย่าง อย่างแรก คือจำนวน tokens ที่กันไว้จากยอดคงเหลือของคุณเมื่อคำขอเริ่ม เมื่อคำตอบสมบูรณ์ จำนวนนั้นจะถูกแทนที่ด้วย tokens ที่คำขอใช้จริง หาก max_tokens มากกว่ายอดที่เหลือในยอดคงเหลือของคุณ คำขอจะคืน 429 Quota exceeded แม้ว่าคำตอบจริงจะพอก็ตาม ส่ง max_tokens ที่ต่ำลงเพื่อกันไว้น้อยลง

shannon-coder-1 นับต่างออกไปบน endpoint นี้: แต่ละคำขอนับเป็นหนึ่งการเรียก Shannon Coder ของแผนของคุณ และไม่มีการกัน tokens ไว้ ขีดจำกัดและยอดคงเหลือ

อย่างที่สอง คือจำกัดความยาวของคำตอบบนโมเดลเหล่านี้:

หากไม่ระบุ max_tokens หรือ max_completion_tokens ค่าจะเป็น 4,096 และบน shannon-coder-1 เป็น 65,536

Messages

แต่ละข้อความเป็นออบเจกต์ที่มี role และ content โดย content เป็นสตริง หรืออาร์เรย์ของส่วนต่างๆ เมื่อข้อความมีมากกว่าข้อความธรรมดา

กับ id ในตระกูล Shannon 3 ให้ใส่คำสั่งที่ต้องคงไว้ลงในข้อความ user

บนระดับ Shannon คำขอที่ไม่มีข้อความของผู้ใช้และไม่มี tools จะคืน 400 No user message provided

ส่วนของเนื้อหา

ขนาด ข้อจำกัด และรายการรูปแบบทั้งหมดมีหน้าของตัวเอง รูปภาพและไฟล์

ออบเจกต์คำตอบ

เหตุผลที่จบ

คำตอบที่ไม่ได้สตรีมจะรายงาน stop หรือ tool_calls

Usage

บนโมเดล open-weight ที่โฮสต์ prompt_tokens คือข้อความและนิยาม tool ของคุณที่นับด้วย tokenizer ของโมเดลเอง บวก tokens ของรูปภาพ (ถ้ามี) endpoint นับ tokens คืนตัวเลขเดียวกันก่อนที่คุณจะส่ง การนับ token

บนระดับ Shannon prompt_tokens นับทุกอย่างที่โมเดลอ่านเพื่อเขียนคำตอบ จึงมากกว่าข้อความของคุณเพียงอย่างเดียว

การสตรีม

เมื่อตั้งค่า stream เป็น true คำตอบจะมาถึงเป็นอีเวนต์ chat.completion.chunk และจบด้วย data: [DONE] chunk สุดท้ายก่อนหน้านั้นมี finish_reason และ usage ไม่ต้องใช้ stream_options รูปแบบของ chunk บรรทัด keep-alive และข้อผิดพลาดภายในสตรีมมีหน้าของตัวเอง สตรีมมิง

ข้อผิดพลาด

ข้อผิดพลาดคือออบเจกต์ JSON ที่มีสมาชิก error การตรวจสอบทำตามลำดับนี้: API key, body ของคำขอ, model id แล้วจึงยอดคงเหลือ ตารางแสดงสิ่งที่ endpoint นี้คืนบ่อยที่สุด รายการทั้งหมดพร้อมวิธีตัดสินใจว่าควรลองใหม่หรือไม่มีหน้าของตัวเอง การจัดการข้อผิดพลาด

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