Chat Completions

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

ຄຳຮ້ອງຂໍທີ່ນ້ອຍທີ່ສຸດແມ່ນ id ຂອງ model ແລະ ຂໍ້ຄວາມ 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."}]
  }'

ຄຳຕອບແມ່ນ object 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
  }
}

Headers

Request headers

Reply headers

ຟີລດ໌ຂອງຄຳຮ້ອງຂໍ

ຕ້ອງມີພຽງ messages. ຄໍລຳ ໃຊ້ໂດຍ ລະບຸ model ທີ່ຟີວນັ້ນປ່ຽນຄຳຕອບ. Hosted open-weight models ແມ່ນສິບສອງ id ໃນລາຍການ model; ຕະກູນ Shannon 3 ແມ່ນ shannon-3, shannon-3-pro, shannon-3.1 ແລະ shannon-3.1-pro. Model ແລະ ລາຄາ

ຟີວອື່ນຂອງ OpenAI, ເຊັ່ນ n, user, stream_options, parallel_tool_calls, presence_penalty, frequency_penalty, logit_bias, logprobs, metadata, store ແລະ prompt_cache_key, ຖືກຮັບໄວ້ເພື່ອໃຫ້ໂຄ້ດ client ເດີມເຮັດວຽກໄດ້ໂດຍບໍ່ຕ້ອງແກ້. ມັນບໍ່ປ່ຽນຄຳຕອບ: ມີ choice ດຽວສະເໝີ, ແລະ stream ຈົບດ້ວຍ usage ສະເໝີ.

ຟີລດ໌ທີ່ມີປະເພດ JSON ຜິດ, ຕົວຢ່າງ "max_tokens": "100", ຈະສົ່ງ 422 ກັບຄືນ. ຄຳຮ້ອງຂໍທີ່ບໍ່ມີ messages ກໍຄືກັນ.

Tools, structured output, reasoning ແລະ web search ແຕ່ລະຢ່າງມີໜ້າຂອງຕົນເອງ: ການເອີ້ນຟັງຊັນ, ຜົນອອກມີໂຄງສ້າງ, Reasoning effort, ຄົ້ນຫາເວັບ.

ຄຳຮ້ອງຂໍທີ່ມີ options

ຄຳຮ້ອງຂໍນີ້ຕັ້ງຂໍ້ຄວາມ system, ຟີລດ໌ sampling ແລະ ລະດັບ reasoning effort. ມັນໃຊ້ hosted open-weight model ເຊິ່ງນຳໃຊ້ທັງໝົດນີ້.

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 ຂອງມັນເພີ່ມສອງລາຍລະອຽດໃນ hosted open-weight models: prompt tokens ທີ່ອ່ານຈາກ cache ແລະ tokens ທີ່ໃຊ້ໄປກັບ reasoning.

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

ຄວາມຍາວຂອງ output

max_tokens ເຮັດສອງຢ່າງ. ຢ່າງທຳອິດ, ມັນແມ່ນຈຳນວນ tokens ທີ່ຖືກກັນໄວ້ຈາກ ຍອດເງິນ ຂອງທ່ານເມື່ອຄຳຮ້ອງຂໍເລີ່ມຕົ້ນ. ເມື່ອຄຳຕອບສົມບູນ, ຈຳນວນນັ້ນຈະຖືກແທນທີ່ດ້ວຍ tokens ທີ່ຄຳຮ້ອງຂໍໃຊ້ຈິງ. ຖ້າ max_tokens ໃຫຍ່ກວ່າສິ່ງທີ່ເຫຼືອຢູ່ໃນ ຍອດເງິນ ຂອງທ່ານ, ຄຳຮ້ອງຂໍຈະສົ່ງ 429 Quota exceeded ກັບຄືນ ເຖິງແມ່ນວ່າຄຳຕອບເອງຈະຢູ່ໃນຂອບເຂດກໍຕາມ. ສົ່ງ max_tokens ທີ່ຕ່ຳລົງເພື່ອກັນໄວ້ໜ້ອຍລົງ.

shannon-coder-1 ຖືກນັບແຕກຕ່າງກັນໃນ endpoint ນີ້: ແຕ່ລະຄຳຮ້ອງຂໍແມ່ນໜຶ່ງການເອີ້ນ Shannon Coder ຂອງແຜນຂອງທ່ານ, ແລະ ບໍ່ມີ tokens ຖືກກັນໄວ້ສຳລັບມັນ. ຂີດຈຳກັດ ແລະ ຍອດເງິນ

ຢ່າງທີສອງ, ມັນຈຳກັດຄວາມຍາວຂອງຄຳຕອບໃນ model ເຫຼົ່ານີ້:

ຖ້າບໍ່ມີ max_tokens ຫຼື max_completion_tokens, ຄ່າແມ່ນ 4,096. ໃນ shannon-coder-1 ແມ່ນ 65,536.

ຂໍ້ຄວາມ

ແຕ່ລະຂໍ້ຄວາມເປັນ object ທີ່ມີ role ແລະ content. content ເປັນ string, ຫຼື array ຂອງສ່ວນຕ່າງໆ ເມື່ອຂໍ້ຄວາມມີຫຼາຍກວ່າຂໍ້ຄວາມຕົວອັກສອນ.

ກັບ id ໃນຕະກູນ Shannon 3, ໃຫ້ໃສ່ຄຳແນະນຳທີ່ຕ້ອງປະຕິບັດຕາມໄວ້ໃນຂໍ້ຄວາມ user.

ໃນລະດັບ Shannon, ຄຳຮ້ອງຂໍທີ່ບໍ່ມີຂໍ້ຄວາມຂອງ user ແລະ ບໍ່ມີ tools ຈະສົ່ງ 400 No user message provided ກັບຄືນ.

ສ່ວນຂອງເນື້ອຫາ

ຂະໜາດ, ຂີດຈຳກັດ ແລະ ລາຍຊື່ຮູບແບບທັງໝົດມີໜ້າຂອງຕົນເອງ. ຮູບພາບ ແລະ ໄຟລ໌

object ຂອງຄຳຕອບ

ເຫດຜົນທີ່ຈົບ

ຄຳຕອບທີ່ບໍ່ແມ່ນ stream ຈະລາຍງານ stop ຫຼື tool_calls.

ການນຳໃຊ້

ໃນ hosted open-weight models, prompt_tokens ແມ່ນຂໍ້ຄວາມ ແລະ ຄຳນິຍາມ tool ຂອງທ່ານທີ່ນັບດ້ວຍ tokenizer ຂອງ model ເອງ, ບວກກັບ tokens ຂອງຮູບພາບໃດໆ. endpoint ນັບ tokens ສົ່ງຕົວເລກດຽວກັນກັບຄືນກ່ອນທີ່ທ່ານຈະສົ່ງ. ການນັບ token

ໃນລະດັບ Shannon, prompt_tokens ນັບທຸກຢ່າງທີ່ model ອ່ານເພື່ອຂຽນຄຳຕອບ, ດັ່ງນັ້ນມັນຈຶ່ງໃຫຍ່ກວ່າຂໍ້ຄວາມຂອງທ່ານເພາະຢ່າງດຽວ.

Streaming

ເມື່ອຕັ້ງ stream ເປັນ true ຄຳຕອບຈະມາເປັນ event chat.completion.chunk ແລະ ຈົບດ້ວຍ data: [DONE]. chunk ສຸດທ້າຍກ່ອນມັນມີ finish_reason ແລະ usage; ບໍ່ຕ້ອງການ stream_options. ຮູບຮ່າງຂອງ chunk, ແຖວ keep-alive ແລະ ຂໍ້ຜິດພາດພາຍໃນ stream ມີໜ້າຂອງຕົນເອງ. ສະຕຣີມມິ້ງ

ຂໍ້ຜິດພາດ

ຂໍ້ຜິດພາດແມ່ນ JSON object ທີ່ມີ member error. ການກວດເຮັດຕາມລຳດັບນີ້: API key, body ຂອງຄຳຮ້ອງຂໍ, model id, ແລ້ວຍອດເງິນ. ຕາຕະລາງລະບຸສິ່ງທີ່ endpoint ນີ້ສົ່ງຄືນເລື້ອຍທີ່ສຸດ. ລາຍການທັງໝົດ ພ້ອມສິ່ງທີ່ຄວນລອງໃໝ່ ມີໜ້າຂອງຕົນເອງ. ການຈັດການຂໍ້ຜິດພາດ

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