Chat Completions

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

Ang pinakamaliit na request ay isang model id at isang user message.

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

Ang reply ay isang JSON object:

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

Mga header

Mga request header

Mga reply header

Mga request field

messages lamang ang kinakailangan. Pinangangalanan ng column na Ina-apply ng ang mga model kung saan binabago ng isang field ang reply. Ang mga hosted open-weight model ay ang labindalawang id sa listahan ng model; ang pamilyang Shannon 3 ay shannon-3, shannon-3-pro, shannon-3.1 at shannon-3.1-pro. Mga model at presyo

Tinatanggap ang iba pang OpenAI field, gaya ng n, user, stream_options, parallel_tool_calls, presence_penalty, frequency_penalty, logit_bias, logprobs, metadata, store at prompt_cache_key, para tumakbo nang walang pagbabago ang kasalukuyang client code. Hindi nila binabago ang reply: palaging iisa ang choice, at palaging nagtatapos sa usage ang stream.

Ang field na may maling JSON type, halimbawa "max_tokens": "100", ay nagbabalik ng 422. Ganoon din ang request na walang messages.

May sariling pahina ang tools, structured output, reasoning at web search: Function calling, Structured outputs, Reasoning effort, Web search.

Isang request na may mga opsyon

Nagtatakda ang request na ito ng system message, mga sampling field at reasoning effort. Gumagamit ito ng hosted open-weight model, na ina-apply ang lahat ng ito.

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

Kapareho ng hugis sa itaas ang reply. Nagdaragdag ang usage nito ng dalawang detalye sa mga hosted open-weight model: ang mga prompt token na binasa mula sa cache at ang mga token na ginugol sa reasoning.

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

Haba ng output

Dalawa ang ginagawa ng max_tokens. Una, ito ang bilang ng token na itinatabi mula sa iyong balance kapag nagsimula ang request. Kapag kumpleto na ang reply, pinapalitan ang halagang iyon ng mga token na aktuwal na nagamit ng request. Kung mas malaki ang max_tokens kaysa sa natitira sa iyong balance, nagbabalik ang request ng 429 Quota exceeded kahit kasya sana ang mismong reply. Magpadala ng mas mababang max_tokens para mas kaunti ang maitabi.

Iba ang pagbilang sa shannon-coder-1 sa endpoint na ito: ang bawat request ay isa sa Shannon Coder calls ng iyong plan, at walang token na itinatabi para rito. Mga limitasyon at balance

Pangalawa, nililimitahan nito ang haba ng reply sa mga model na ito:

Kung walang max_tokens o max_completion_tokens, ang value ay 4,096. Sa shannon-coder-1 ay 65,536.

Messages

Ang bawat message ay isang object na may role at content. Ang content ay isang string, o isang array ng mga part kapag may dalang higit sa text ang message.

Sa isang id ng pamilyang Shannon 3, ilagay sa user message ang mga tagubiling dapat masunod.

Sa mga Shannon tier, ang request na walang user text at walang tools ay nagbabalik ng 400 No user message provided.

Mga content part

May sariling pahina ang mga laki, limitasyon at ang buong listahan ng mga anyo. Mga image at file

Ang reply object

Mga dahilan ng pagtatapos

Ang reply na hindi naka-stream ay nag-uulat ng stop o tool_calls.

Usage

Sa mga hosted open-weight model, ang prompt_tokens ay ang iyong mga message at tool definition na binilang gamit ang sariling tokenizer ng model, dagdag ang mga token ng anumang image. Ibinabalik ng mga token counting endpoint ang parehong numero bago ka magpadala. Pagbibilang ng token

Sa mga Shannon tier, binibilang ng prompt_tokens ang lahat ng binasa ng model para isulat ang reply, kaya mas malaki ito kaysa sa text ng iyong mga message lamang.

Streaming

Kapag naka-set ang stream sa true, dumarating ang reply bilang mga chat.completion.chunk event at nagtatapos sa data: [DONE]. Dala ng huling chunk bago nito ang finish_reason at usage; walang kailangang stream_options. May sariling pahina ang mga hugis ng chunk, keep-alive line at mga error sa loob ng stream. Pag‑stream

Mga error

Ang error ay isang JSON object na may miyembrong error. Tumatakbo ang mga pagsusuri sa pagkakasunod na ito: API key, request body, model id, saka balance. Inililista ng talahanayan ang pinakamadalas na ibinabalik ng endpoint na ito. May sariling pahina ang buong listahan, kasama kung ano ang dapat i-retry. Paghawak ng Error

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