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 הוא חובה. העמודה מופעל על ידי מציינת את המודלים שבהם שדה משנה את התשובה. מודלי ה-open-weight המתארחים הם שנים-עשר המזהים ברשימת המודלים; משפחת 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 אחד, ו-stream תמיד מסתיים בנתוני שימוש.

שדה עם סוג JSON שגוי, למשל "max_tokens": "100", מחזיר 422. כך גם בקשה בלי messages.

לכלים, לפלט מובנה, ל-reasoning ולחיפוש ברשת יש לכל אחד דף משלו: קריאת פונקציות, פלט מובנה, רמת מאמץ ה-reasoning, חיפוש ווב מובנה.

בקשה עם אפשרויות

הבקשה הזו קובעת הודעת system, את שדות הדגימה ואת רמת המאמץ של ה-reasoning. היא משתמשת במודל open-weight מתארח, שמיישם את כולם.

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 שלה מוסיף שני פרטים במודלי ה-open-weight המתארחים: טוקני הפרומפט שנקראו מהמטמון והטוקנים שהושקעו ב-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 נמוך יותר כדי להפריש פחות.

shannon-coder-1 נספר אחרת ב-endpoint הזה: כל בקשה היא אחת מקריאות Shannon Coder של התוכנית שלכם, ולא מופרשים בשבילה טוקנים. מגבלות ויתרה

שנית, הוא מגביל את אורך התשובה במודלים האלה:

בלי 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.

חלקי תוכן

לגדלים, למגבלות ולרשימה המלאה של הצורות יש דף משלהם. תמונות וקבצים

אובייקט התשובה

סיבות סיום

תשובה שאינה ב-streaming מדווחת stop או tool_calls.

שימוש

במודלי ה-open-weight המתארחים, prompt_tokens הוא ההודעות והגדרות הכלים שלכם נספרים עם ה-tokenizer של המודל עצמו, ועוד הטוקנים של תמונות. ה-endpoints לספירת טוקנים מחזירים את אותו מספר לפני השליחה. ספירת טוקנים

בדרגי Shannon, prompt_tokens סופר את כל מה שהמודל קרא כדי לכתוב את התשובה, ולכן הוא גדול מטקסט ההודעות שלכם לבדו.

Streaming

כש-stream מוגדר ל-true התשובה מגיעה כאירועי chat.completion.chunk ומסתיימת ב-data: [DONE]. ה-chunk האחרון לפניו נושא finish_reason ו-usage; אין צורך ב-stream_options. לצורות ה-chunk, לשורות keep-alive ולשגיאות בתוך stream יש דף משלהן. הזרמה

שגיאות

שגיאה היא אובייקט JSON עם איבר error. הבדיקות רצות בסדר הזה: מפתח API, גוף הבקשה, מזהה המודל, ואז היתרה. הטבלה מפרטת את מה שה-endpoint הזה מחזיר לרוב. הרשימה המלאה, עם מה שכדאי לנסות שוב, נמצאת בדף משלה. טיפול בשגיאות

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