Chat Completions

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

En küçük istek, bir model kimliği ve bir kullanıcı 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."}]
  }'

Yanıt tek bir JSON nesnesidir:

{
  "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ıklar

İstek başlıkları

Yanıt başlıkları

İstek alanları

Yalnızca messages zorunludur. Uygulayan sütunu, bir alanın yanıtı değiştirdiği modelleri belirtir. Host edilen açık ağırlıklı modeller, model listesindeki on iki kimliktir; Shannon 3 ailesi shannon-3, shannon-3-pro, shannon-3.1 ve shannon-3.1-pro kimlikleridir. Modeller ve fiyatlandırma

n, user, stream_options, parallel_tool_calls, presence_penalty, frequency_penalty, logit_bias, logprobs, metadata, store ve prompt_cache_key gibi diğer OpenAI alanları, mevcut istemci kodu değişmeden çalışsın diye kabul edilir. Yanıtı değiştirmezler: her zaman tek bir seçenek vardır ve bir akış her zaman kullanım bilgisiyle biter.

JSON türü yanlış olan bir alan, örneğin "max_tokens": "100", 422 döndürür. messages olmayan bir istek de öyle.

Araçların, yapılandırılmış çıktının, akıl yürütmenin ve web aramasının her birinin kendi sayfası var: Fonksiyon Çağırma, Yapılandırılmış Çıktılar, Akıl yürütme çabası, Yerleşik Web Arama.

Seçenekli bir istek

Bu istek bir sistem mesajı, örnekleme alanları ve akıl yürütme çabasını ayarlar. Hepsini uygulayan, host edilen bir açık ağırlıklı model kullanı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="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"
  }'

Yanıt, yukarıdakiyle aynı yapıdadır. Host edilen açık ağırlıklı modellerde usage alanı iki ayrıntı ekler: önbellekten okunan istem token'ları ve akıl yürütmeye harcanan token'lar.

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

Çıktı uzunluğu

max_tokens iki şey yapar. Birincisi, istek başladığında bakiyenizden ayrılan token sayısıdır. Yanıt tamamlandığında bu miktar, isteğin kullandığı token'larla değiştirilir. max_tokens, bakiyenizde kalandan büyükse yanıtın kendisi sığacak olsa bile istek 429 Quota exceeded döndürür. Daha az ayırmak için daha düşük bir max_tokens gönderin.

shannon-coder-1 bu uç noktada farklı sayılır: her istek planınızın Shannon Coder çağrılarından biridir ve onun için token ayrılmaz. Limitler ve bakiye

İkincisi, şu modellerde yanıtın uzunluğunu sınırlar:

max_tokens veya max_completion_tokens olmadan değer 4,096'dır. shannon-coder-1 üzerinde 65,536'dır.

Mesajlar

Her mesaj, bir role ve bir content içeren bir nesnedir. content bir dizge veya mesaj metinden fazlasını taşıdığında bir parça dizisidir.

Bir Shannon 3 ailesi kimliğiyle, geçerli olması gereken talimatları user mesajına koyun.

Shannon katmanlarında kullanıcı metni ve tools olmayan bir istek 400 No user message provided döndürür.

İçerik parçaları

Boyutların, sınırların ve biçimlerin tam listesinin kendi sayfası var. Görseller ve dosyalar

Yanıt nesnesi

Bitiş nedenleri

Akışsız bir yanıt stop veya tool_calls bildirir.

Kullanım

Host edilen açık ağırlıklı modellerde prompt_tokens, mesajlarınızın ve araç tanımlarınızın modelin kendi tokenizer'ıyla sayılması ile varsa görsellerin token'larının toplamıdır. Token sayma uç noktaları, siz göndermeden önce aynı sayıyı döndürür. Token sayma

Shannon katmanlarında prompt_tokens, modelin yanıtı yazmak için okuduğu her şeyi sayar; bu yüzden yalnızca mesajlarınızın metninden büyüktür.

Streaming

stream değeri true olduğunda yanıt chat.completion.chunk olayları olarak gelir ve data: [DONE] ile biter. Ondan önceki son parça finish_reason ve usage taşır; stream_options gerekmez. Parça yapılarının, keep-alive satırlarının ve bir akışın içindeki hataların kendi sayfası var. Akış

Hatalar

Hata, bir error üyesi olan bir JSON nesnesidir. Kontroller şu sırayla çalışır: API anahtarı, istek gövdesi, model kimliği, sonra bakiye. Tablo, bu uç noktanın en sık döndürdüklerini listeler. Hangi hataların yeniden deneneceğini de içeren tam listenin kendi sayfası var. Hata yönetimi

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