Chat Completions

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

সবচেয়ে ছোট রিকোয়েস্ট হলো একটি মডেল 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 আবশ্যক। যারা প্রয়োগ করে কলামে সেই মডেলগুলোর নাম আছে যেগুলোতে একটি ফিল্ড উত্তর বদলায়। হোস্টেড ওপেন-ওয়েট মডেল হলো মডেল তালিকার বারোটি 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 থাকে, এবং স্ট্রিম সবসময় ইউসেজ দিয়ে শেষ হয়।

ভুল JSON টাইপের ফিল্ড, যেমন "max_tokens": "100", 422 রিটার্ন করে। messages ছাড়া রিকোয়েস্টও তা-ই করে।

টুলস, স্ট্রাকচার্ড আউটপুট, রিজনিং ও ওয়েব সার্চের প্রতিটির নিজস্ব পেজ আছে: ফাংশন কলিং, স্ট্রাকচার্ড আউটপুট, রিজনিং effort, ওয়েব সার্চ.

অপশন সহ একটি রিকোয়েস্ট

এই রিকোয়েস্টে একটি সিস্টেম মেসেজ, স্যাম্পলিং ফিল্ড এবং রিজনিং effort সেট করা হয়। এটি একটি হোস্টেড ওপেন-ওয়েট মডেল ব্যবহার করে, যা সবগুলো প্রয়োগ করে।

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 দুটি বিবরণ যোগ করে: ক্যাশ থেকে পড়া প্রম্পট 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 ভিন্নভাবে গণনা হয়: প্রতিটি রিকোয়েস্ট আপনার প্ল্যানের একটি Shannon Coder কল, এবং এর জন্য কোনো tokens আলাদা করে রাখা হয় না। সীমা ও ব্যালেন্স

দ্বিতীয়ত, এটি এই মডেলগুলোতে উত্তরের দৈর্ঘ্য সীমিত করে:

max_tokens বা max_completion_tokens ছাড়া মান 4,096। shannon-coder-1-এ এটি 65,536।

মেসেজ

প্রতিটি মেসেজ একটি role ও একটি content সহ অবজেক্ট। content হলো একটি স্ট্রিং, অথবা মেসেজ শুধু টেক্সটের বেশি কিছু বহন করলে অংশের একটি অ্যারে।

Shannon 3 ফ্যামিলির কোনো id-র ক্ষেত্রে, যেসব নির্দেশনা অবশ্যই মানতে হবে তা user মেসেজে দিন।

Shannon টিয়ারগুলোতে ইউজার টেক্সট ও tools ছাড়া রিকোয়েস্ট 400 No user message provided রিটার্ন করে।

কনটেন্ট অংশ

সাইজ, লিমিট এবং ফর্মের সম্পূর্ণ তালিকার জন্য আলাদা পেজ আছে। ইমেজ ও ফাইল

উত্তরের অবজেক্ট

ফিনিশ রিজন

স্ট্রিম না করা উত্তর stop বা tool_calls জানায়।

ইউসেজ

হোস্টেড ওপেন-ওয়েট মডেলগুলোতে prompt_tokens হলো আপনার মেসেজ ও টুল সংজ্ঞা মডেলের নিজস্ব টোকেনাইজার দিয়ে গণনা করা, সঙ্গে যেকোনো ইমেজের tokens। token গণনার এন্ডপয়েন্টগুলো পাঠানোর আগেই একই সংখ্যা রিটার্ন করে। Token গণনা

Shannon টিয়ারগুলোতে prompt_tokens উত্তর লিখতে মডেল যা কিছু পড়েছে সবকিছু গণনা করে, তাই এটি শুধু আপনার মেসেজের টেক্সটের চেয়ে বড় হয়।

স্ট্রিমিং

stream true সেট করলে উত্তর chat.completion.chunk ইভেন্ট হিসেবে আসে এবং data: [DONE] দিয়ে শেষ হয়। এর আগের শেষ চাংকে finish_reason ও usage থাকে; কোনো stream_options লাগে না। চাংকের গঠন, কিপ-অ্যালাইভ লাইন এবং স্ট্রিমের ভেতরের এররের জন্য আলাদা পেজ আছে। স্ট্রিমিং

এরর

এরর হলো error সদস্য সহ একটি JSON অবজেক্ট। যাচাই এই ক্রমে চলে: API key, রিকোয়েস্ট বডি, মডেল id, তারপর ব্যালেন্স। টেবিলে এই এন্ডপয়েন্ট সবচেয়ে বেশি যা রিটার্ন করে তা দেওয়া আছে। কোনটি আবার চেষ্টা করতে হবে সহ সম্পূর্ণ তালিকার জন্য আলাদা পেজ আছে। এরর হ্যান্ডলিং

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