Chat Completions

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

ყველაზე მცირე მოთხოვნა მოდელის id-ა და ერთი user შეტყობინებაა.

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

Header-ები

მოთხოვნის header-ები

პასუხის header-ები

მოთხოვნის ველები

სავალდებულოა მხოლოდ messages. სვეტი მოქმედებს ასახელებს მოდელებს, რომლებზეც ველი პასუხს ცვლის. Hosted open-weight მოდელები მოდელების სიის თორმეტი 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 არსებობს და სტრიმი ყოველთვის usage-ით მთავრდება.

ველი JSON-ის არასწორი ტიპით, მაგალითად "max_tokens": "100", აბრუნებს 422-ს. ასევე მოთხოვნა messages-ის გარეშე.

ინსტრუმენტებს, სტრუქტურირებულ შედეგს, მსჯელობასა და ვებძიებას თითოეულს საკუთარი გვერდი აქვს: ფუნქციის გამოძახება, სტრუქტურირებული შედეგები, მსჯელობის effort, ჩაშენებული ვებძიება.

მოთხოვნა პარამეტრებით

ეს მოთხოვნა ადგენს system შეტყობინებას, სემპლინგის ველებსა და მსჯელობის effort-ს. ის იყენებს hosted 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 hosted open-weight მოდელებზე ორ დეტალს ამატებს: ქეშიდან წაკითხულ პრომპტის ტოკენებს და მსჯელობაზე დახარჯულ ტოკენებს.

{
  "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 ოჯახის id-ის შემთხვევაში ინსტრუქციები, რომლებიც აუცილებლად უნდა შესრულდეს, user შეტყობინებაში ჩაწერეთ.

Shannon-ის დონეებზე მოთხოვნა მომხმარებლის ტექსტისა და tools-ის გარეშე აბრუნებს 400 No user message provided-ს.

შიგთავსის ნაწილები

ზომებს, ლიმიტებსა და ფორმების სრულ სიას საკუთარი გვერდი აქვს. სურათები და ფაილები

პასუხის ობიექტი

დასრულების მიზეზები

არასტრიმული პასუხი აჩვენებს stop-ს ან tool_calls-ს.

გამოყენება

Hosted open-weight მოდელებზე prompt_tokens არის თქვენი შეტყობინებები და ინსტრუმენტების აღწერები, დათვლილი მოდელის საკუთარი ტოკენიზატორით, პლუს ნებისმიერი სურათის ტოკენები. ტოკენების დათვლის endpoint-ები იმავე რიცხვს აბრუნებენ გაგზავნამდე. ტოკენების დათვლა

Shannon-ის დონეებზე prompt_tokens ითვლის ყველაფერს, რაც მოდელმა პასუხის დასაწერად წაიკითხა, ამიტომ ის მხოლოდ თქვენი შეტყობინებების ტექსტზე დიდია.

სტრიმინგი

როცა stream არის true, პასუხი მოდის chat.completion.chunk მოვლენებად და მთავრდება data: [DONE]-თი. მის წინ ბოლო chunk ატარებს finish_reason-სა და usage-ს; stream_options საჭირო არ არის. chunk-ების ფორმებს, keep-alive ხაზებსა და სტრიმის შიგნით შეცდომებს საკუთარი გვერდი აქვს. სტრიმინგი

შეცდომები

შეცდომა არის JSON ობიექტი error წევრით. შემოწმებები ამ თანმიმდევრობით სრულდება: API გასაღები, მოთხოვნის body, მოდელის id, შემდეგ ბალანსი. ცხრილში მოცემულია, რას აბრუნებს ეს endpoint ყველაზე ხშირად. სრულ სიას, იმის მითითებით, რა უნდა განმეორდეს, საკუთარი გვერდი აქვს. შეცდომების დამუშავება

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