Chat Completions

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

أصغر طلب هو معرّف نموذج ورسالة مستخدم واحدة.

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 وحده مطلوب. يسمّي العمود يطبّقه النماذج التي يغيّر فيها الحقل الرد. النماذج المفتوحة الأوزان المستضافة هي المعرّفات الاثنا عشر في قائمة النماذج؛ وعائلة 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، حتى تعمل شيفرة العميل الحالية دون تغيير. لا تغيّر هذه الحقول الرد: يوجد دائماً اختيار واحد، وينتهي البث دائماً بالاستخدام.

الحقل الذي له نوع JSON خاطئ، مثل "max_tokens": "100"، يعيد 422. وكذلك الطلب الذي لا يحتوي على messages.

للأدوات والمخرجات المنظمة والاستدلال والبحث في الويب صفحة خاصة بكل منها: استدعاء الدوال, مخرجات منظمة, جهد الاستدلال, بحث ويب مدمج.

طلب مع خيارات

يحدد هذا الطلب رسالة نظام وحقول أخذ العينات وجهد الاستدلال. ويستخدم نموذجاً مفتوح الأوزان مستضافاً، يطبّق كل ذلك.

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، ضع التعليمات التي يجب الالتزام بها في رسالة user.

في مستويات Shannon يعيد الطلب الذي لا نص للمستخدم فيه ولا tools الخطأ 400 No user message provided.

أجزاء المحتوى

للأحجام والحدود والقائمة الكاملة للأشكال صفحة خاصة. الصور والملفات

كائن الرد

أسباب الانتهاء

الرد غير المبثوث يُبلِّغ عن stop أو tool_calls.

الاستخدام

في النماذج المفتوحة الأوزان المستضافة، prompt_tokens هي رسائلك وتعريفات الأدوات محسوبة بمجزّئ النموذج نفسه (tokenizer)، مضافاً إليها tokens أي صور. وتعيد نقاط نهاية عدّ tokens الرقم نفسه قبل أن ترسل. عدّ الـ tokens

في مستويات Shannon، تحسب prompt_tokens كل ما قرأه النموذج ليكتب الرد، لذا فهي أكبر من نص رسائلك وحده.

البث

عند ضبط stream على true يصل الرد كأحداث chat.completion.chunk وينتهي بـ data: [DONE]. يحمل الجزء الأخير قبله finish_reason وusage؛ ولا حاجة إلى stream_options. لأشكال الأجزاء وأسطر إبقاء الاتصال حياً والأخطاء داخل البث صفحة خاصة. البث

الأخطاء

الخطأ كائن JSON فيه عضو error. تجري الفحوص بهذا الترتيب: مفتاح API، ثم نص الطلب، ثم معرّف النموذج، ثم الرصيد. يسرد الجدول ما تعيده نقطة النهاية هذه في الغالب. أما القائمة الكاملة، مع ما يجب إعادة محاولته، فلها صفحتها الخاصة. معالجة الأخطاء

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