Chat Completions

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

Kërkesa më e vogël është një id modeli dhe një mesazh përdoruesi.

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

Përgjigjja është një objekt 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-at

Header-at e kërkesës

Header-at e përgjigjes

Fushat e kërkesës

Vetëm messages është i detyrueshëm. Kolona Zbatohet nga emërton modelet te të cilat një fushë ndryshon përgjigjen. Modelet open-weight të hostuara janë dymbëdhjetë id-të e listës së modeleve; familja Shannon 3 është shannon-3, shannon-3-pro, shannon-3.1 dhe shannon-3.1-pro. Modelet dhe çmimet

Fusha të tjera OpenAI, si n, user, stream_options, parallel_tool_calls, presence_penalty, frequency_penalty, logit_bias, logprobs, metadata, store dhe prompt_cache_key, pranohen që kodi ekzistues i klientit të punojë pa ndryshime. Ato nuk e ndryshojnë përgjigjen: ka gjithmonë një choice, dhe një stream mbaron gjithmonë me përdorim.

Një fushë me lloj JSON të gabuar, për shembull "max_tokens": "100", kthen 422. Po ashtu edhe një kërkesë pa messages.

Mjetet, dalja e strukturuar, arsyetimi dhe kërkimi në ueb kanë secili faqen e vet: Thirrje funksionesh, Dalje të strukturuara, Përpjekja e arsyetimit, Kërkim i integruar në ueb.

Një kërkesë me opsione

Kjo kërkesë cakton një mesazh sistemi, fushat e kampionimit dhe përpjekjen e arsyetimit. Përdor një model open-weight të hostuar, i cili i zbaton të gjitha.

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

Përgjigjja ka të njëjtën formë si më sipër. usage i saj shton dy detaje te modelet open-weight të hostuara: tokens-at e prompt-it të lexuar nga cache-i dhe tokens-at e shpenzuar për arsyetim.

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

Gjatësia e daljes

max_tokens bën dy gjëra. Së pari, është numri i tokens-ave që rezervohet nga bilanci juaj kur kërkesa fillon. Kur përgjigjja është e plotë, ajo sasi zëvendësohet me tokens-at që përdori kërkesa. Nëse max_tokens është më i madh se ç'ka mbetur nga bilanci juaj, kërkesa kthen 429 Quota exceeded edhe kur vetë përgjigjja do të kishte ngjitur. Dërgoni një max_tokens më të ulët për të rezervuar më pak.

shannon-coder-1 numërohet ndryshe në këtë endpoint: çdo kërkesë është një nga thirrjet Shannon Coder të planit tuaj, dhe për të nuk rezervohen tokens. Kufijtë dhe bilanci

Së dyti, kufizon gjatësinë e përgjigjes te këto modele:

Pa max_tokens ose max_completion_tokens, vlera është 4,096. Te shannon-coder-1 është 65,536.

Mesazhet

Çdo mesazh është një objekt me role dhe content. content është një string, ose një varg pjesësh kur mesazhi mban më shumë se tekst.

Me një id të familjes Shannon 3, vendosini udhëzimet që duhet të mbahen në mesazhin user.

Te nivelet Shannon një kërkesë pa tekst përdoruesi dhe pa tools kthen 400 No user message provided.

Pjesët e përmbajtjes

Madhësitë, kufijtë dhe lista e plotë e formave kanë faqen e tyre. Imazhet dhe skedarët

Objekti i përgjigjes

Arsyet e mbarimit

Një përgjigje pa stream raporton stop ose tool_calls.

Përdorimi

Te modelet open-weight të hostuara, prompt_tokens janë mesazhet dhe përkufizimet tuaja të mjeteve të numëruara me tokenizuesin e vetë modelit, plus tokens-at e çdo imazhi. Endpoint-et e numërimit të tokens-ave kthejnë të njëjtin numër para se të dërgoni. Numërimi i tokens-ave

Te nivelet Shannon, prompt_tokens numëron gjithçka që modeli lexoi për të shkruar përgjigjen, kështu që është më i madh se vetëm teksti i mesazheve tuaja.

Streaming

Me stream të vendosur në true përgjigjja arrin si ngjarje chat.completion.chunk dhe mbaron me data: [DONE]. Pjesa e fundit para tij mban finish_reason dhe usage; nuk nevojiten stream_options. Format e pjesëve, rreshtat keep-alive dhe gabimet brenda një stream-i kanë faqen e tyre. Transmetim

Gabimet

Një gabim është një objekt JSON me anëtar error. Kontrollet kryhen në këtë radhë: çelësi API, trupi i kërkesës, id-ja e modelit, pastaj bilanci. Tabela liston ato që ky endpoint kthen më shpesh. Lista e plotë, me atë që duhet provuar përsëri, ka faqen e vet. Trajtimi i gabimeve

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