Chat Completions

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

Ən kiçik sorğu model id-si və bir istifadəçi mesajıdır.

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."}]
  }'

Cavab bir JSON obyektidir:

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

Başlıqlar

Sorğu başlıqları

Cavab başlıqları

Sorğu sahələri

Yalnız messages məcburidir. Tətbiq edən sütunu sahənin cavabı dəyişdirdiyi modelləri göstərir. Host edilmiş açıq çəkili modellər model siyahısındakı on iki id-dir; Shannon 3 ailəsi shannon-3, shannon-3-pro, shannon-3.1 və shannon-3.1-pro-dur. Modellər və qiymətlər

Digər OpenAI sahələri, məsələn n, user, stream_options, parallel_tool_calls, presence_penalty, frequency_penalty, logit_bias, logprobs, metadata, store və prompt_cache_key, mövcud klient kodu dəyişmədən işləsin deyə qəbul edilir. Onlar cavabı dəyişmir: həmişə bir choice olur və axın həmişə istifadə məlumatı ilə bitir.

JSON tipi yanlış olan sahə, məsələn "max_tokens": "100", 422 qaytarır. messages olmayan sorğu da belədir.

Alətlər, strukturlaşdırılmış çıxış, reasoning və veb axtarışının hər birinin ayrıca səhifəsi var: Funksiya çağırışı, Strukturlaşdırılmış çıxışlar, Reasoning effort, Veb axtarışı.

Seçimləri olan sorğu

Bu sorğu system mesajı, seçmə sahələri və reasoning effort təyin edir. O, hamısını tətbiq edən host edilmiş açıq çəkili modeldən istifadə edir.

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

Cavab yuxarıdakı ilə eyni formadadır. Host edilmiş açıq çəkili modellərdə onun usage sahəsi iki təfərrüat əlavə edir: keşdən oxunan prompt tokenləri və reasoning-ə sərf olunan tokenlər.

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

Çıxış uzunluğu

max_tokens iki şey edir. Birincisi, sorğu başlayanda balansınızdan ayrılan tokenlərin sayıdır. Cavab tamamlandıqda həmin məbləğ sorğunun istifadə etdiyi tokenlərlə əvəz olunur. max_tokens balansınızda qalandan böyükdürsə, cavabın özü sığacaq olsa belə sorğu 429 Quota exceeded qaytarır. Daha az ayırmaq üçün daha kiçik max_tokens göndərin.

shannon-coder-1 bu endpoint-də fərqli sayılır: hər sorğu planınızın Shannon Coder çağırışlarından biridir və onun üçün token ayrılmır. Limitlər və balans

İkincisi, bu modellərdə cavabın uzunluğunu məhdudlaşdırır:

max_tokens və ya max_completion_tokens olmadıqda dəyər 4,096-dır. shannon-coder-1-də 65,536-dır.

Mesajlar

Hər mesaj role və content sahələri olan obyektdir. content sətir, yaxud mesaj mətndən çoxunu daşıyırsa hissələr massividir.

Shannon 3 ailəsinin id-si ilə, mütləq yerinə yetirilməli təlimatları user mesajına qoyun.

Shannon səviyyələrində istifadəçi mətni və tools olmayan sorğu 400 No user message provided qaytarır.

Məzmun hissələri

Ölçülər, limitlər və formaların tam siyahısı üçün ayrıca səhifə var. Təsvirlər və fayllar

Cavab obyekti

Bitmə səbəbləri

Axınsız cavab stop və ya tool_calls bildirir.

İstifadə

Host edilmiş açıq çəkili modellərdə prompt_tokens mesajlarınızın və alət təyinlərinin modelin öz tokenizer-i ilə sayılması üstəgəl hər hansı şəkillərin tokenləridir. Token sayma endpoint-ləri göndərməzdən əvvəl eyni ədədi qaytarır. Tokenlərin sayılması

Shannon səviyyələrində prompt_tokens modelin cavabı yazmaq üçün oxuduğu hər şeyi sayır, buna görə o, təkcə mesajlarınızın mətnindən böyükdür.

Streaming

stream dəyəri true olduqda cavab chat.completion.chunk hadisələri kimi gəlir və data: [DONE] ilə bitir. Ondan əvvəlki son chunk finish_reason və usage daşıyır; stream_options lazım deyil. Chunk formaları, keep-alive sətirləri və axın daxilindəki xətaların ayrıca səhifəsi var. Axın

Xətalar

Xəta error üzvü olan JSON obyektidir. Yoxlamalar bu ardıcıllıqla aparılır: API açarı, sorğu gövdəsi, model id-si, sonra balans. Cədvəldə bu endpoint-in ən çox qaytardıqları göstərilib. Təkrar cəhd ediləcəklərlə birgə tam siyahı ayrıca səhifədədir. Xəta idarəetməsi

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