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 لازمی ہے۔ لاگو کرنے والے کالم ان ماڈلز کے نام بتاتا ہے جن پر کوئی فیلڈ جواب کو بدلتا ہے۔ ہوسٹڈ اوپن ویٹ ماڈلز ماڈل فہرست کے بارہ ids ہیں؛ 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 کے بغیر درخواست بھی یہی لوٹاتی ہے۔

ٹولز، ساختی آؤٹ پٹ، reasoning اور ویب سرچ میں سے ہر ایک کا اپنا صفحہ ہے: فنکشن کالنگ, ساختی آؤٹ پٹس, Reasoning effort, ویب تلاش.

آپشنز والی درخواست

یہ درخواست ایک سسٹم پیغام، سیمپلنگ فیلڈز اور reasoning 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 میں دو تفصیلات بڑھ جاتی ہیں: کیش سے پڑھے گئے پرامپٹ ٹوکنز اور reasoning پر خرچ ہونے والے ٹوکنز۔

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

آؤٹ پٹ کی لمبائی

max_tokens دو کام کرتا ہے۔ پہلا، درخواست شروع ہوتے ہی آپ کے بیلنس میں سے اتنے ٹوکنز الگ رکھ لیے جاتے ہیں۔ جواب مکمل ہونے پر یہ مقدار اس سے بدل دی جاتی ہے جتنے ٹوکنز درخواست نے استعمال کیے۔ اگر max_tokens آپ کے بیلنس میں باقی مقدار سے زیادہ ہو تو درخواست 429 Quota exceeded لوٹاتی ہے چاہے جواب خود سما جاتا۔ کم مقدار الگ رکھنے کے لیے کم max_tokens بھیجیں۔

اس endpoint پر shannon-coder-1 کی گنتی مختلف ہے: ہر درخواست آپ کے پلان کی ایک Shannon Coder کال ہے، اور اس کے لیے کوئی ٹوکنز الگ نہیں رکھے جاتے۔ حدود اور بیلنس

دوسرا، یہ ان ماڈلز پر جواب کی لمبائی محدود کرتا ہے:

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 رپورٹ کرتا ہے۔

Usage

ہوسٹڈ اوپن ویٹ ماڈلز پر prompt_tokens آپ کے پیغامات اور ٹول تعریفوں کو ماڈل کے اپنے ٹوکنائزر سے گن کر، علاوہ ازیں تصاویر کے ٹوکنز ملا کر بنتا ہے۔ ٹوکن گنتی والے endpoints بھیجنے سے پہلے یہی عدد لوٹاتے ہیں۔ ٹوکن گنتی

Shannon درجوں پر prompt_tokens وہ سب گنتا ہے جو ماڈل نے جواب لکھنے کے لیے پڑھا، اس لیے یہ صرف آپ کے پیغامات کے متن سے بڑا ہوتا ہے۔

سٹریمنگ

stream کو true پر سیٹ کرنے سے جواب chat.completion.chunk ایونٹس کے طور پر آتا ہے اور data: [DONE] پر ختم ہوتا ہے۔ اس سے پہلے کا آخری chunk finish_reason اور usage رکھتا ہے؛ کسی stream_options کی ضرورت نہیں۔ chunk کی شکلوں، keep-alive لائنوں اور سٹریم کے اندر ایررز کا اپنا صفحہ ہے۔ اسٹریمنگ

ایررز

ایرر ایک JSON آبجیکٹ ہے جس میں error رکن ہوتا ہے۔ جانچ اس ترتیب سے ہوتی ہے: API کلید، درخواست کی باڈی، ماڈل id، پھر بیلنس۔ جدول وہ ایررز دکھاتا ہے جو یہ endpoint سب سے زیادہ لوٹاتا ہے۔ مکمل فہرست، اور کن پر دوبارہ کوشش کرنی ہے، اس کا اپنا صفحہ ہے۔ غلطیاں

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