Chat Completions

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

La plej malgranda peto estas modelo-id kaj unu uzanta mesaĝo.

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

La respondo estas unu JSON-objekto:

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

Kapoj

Kapoj de peto

Kapoj de respondo

Kampoj de peto

Nur messages estas deviga. La kolumno Aplikata de nomas la modelojn, ĉe kiuj kampo ŝanĝas la respondon. La gastigitaj malfermpezaj modeloj estas la dek du id-oj de la modellisto; la familio Shannon 3 estas shannon-3, shannon-3-pro, shannon-3.1 kaj shannon-3.1-pro. Modeloj kaj prezoj

Aliaj kampoj de OpenAI, kiel n, user, stream_options, parallel_tool_calls, presence_penalty, frequency_penalty, logit_bias, logprobs, metadata, store kaj prompt_cache_key, estas akceptataj, por ke ekzistanta klienta kodo funkciu senŝanĝe. Ili ne ŝanĝas la respondon: ĉiam ekzistas unu elekto, kaj fluo ĉiam finiĝas per uzado.

Kampo kun malĝusta JSON-tipo, ekzemple "max_tokens": "100", redonas 422. Peto sen messages same.

Iloj, strukturita eligo, reasoning kaj retserĉo havas ĉiu sian propran paĝon: Funkci-alvokoj, Strukturitaj eligoj, Peno de reasoning, Retserĉo.

Peto kun opcioj

Ĉi tiu peto agordas mesaĝon system, la specimenajn kampojn kaj la penon de reasoning. Ĝi uzas gastigitan malfermpezan modelon, kiu aplikas ĉiujn.

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

La respondo havas la saman formon kiel supre. Ĝia usage aldonas du detalojn ĉe la gastigitaj malfermpezaj modeloj: la prompt-tokenojn legitajn el la kaŝmemoro kaj la tokenojn elspezitajn por reasoning.

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

Longeco de la eligo

max_tokens faras du aferojn. Unue, ĝi estas la nombro de tokenoj rezervitaj el via saldo, kiam la peto komenciĝas. Kiam la respondo estas kompleta, tiu kvanto estas anstataŭigita per la tokenoj, kiujn la peto uzis. Se max_tokens estas pli granda ol tio, kio restas el via saldo, la peto redonas 429 Quota exceeded eĉ se la respondo mem sufiĉus. Sendu pli malaltan max_tokens por rezervi malpli.

shannon-coder-1 estas kalkulata alie ĉe ĉi tiu endpoint: ĉiu peto estas unu el la vokoj de Shannon Coder de via plano, kaj neniuj tokenoj estas rezervataj por ĝi. Limoj kaj saldo

Due, ĝi limigas la longecon de la respondo ĉe ĉi tiuj modeloj:

Sen max_tokens aŭ max_completion_tokens la valoro estas 4,096. Ĉe shannon-coder-1 ĝi estas 65,536.

Mesaĝoj

Ĉiu mesaĝo estas objekto kun role kaj content. content estas ĉeno, aŭ tabelo de partoj, kiam la mesaĝo portas pli ol tekston.

Kun id de la familio Shannon 3 metu instrukciojn, kiuj devas validi, en la mesaĝon user.

Ĉe la Shannon-niveloj peto sen uzanta teksto kaj sen tools redonas 400 No user message provided.

Partoj de enhavo

Grandoj, limoj kaj la plena listo de formoj havas sian propran paĝon. Bildoj kaj dosieroj

La responda objekto

Kialoj de fino

Nefluata respondo raportas stop aŭ tool_calls.

Uzado

Ĉe la gastigitaj malfermpezaj modeloj prompt_tokens estas viaj mesaĝoj kaj ilo-difinoj kalkulitaj per la propra tokenigilo de la modelo, plus la tokenoj de eventualaj bildoj. La endpoints por kalkulado de tokenoj redonas la saman nombron antaŭ ol vi sendas. Kalkulado de tokenoj

Ĉe la Shannon-niveloj prompt_tokens kalkulas ĉion, kion la modelo legis por skribi la respondon, do ĝi estas pli granda ol la teksto de viaj mesaĝoj sola.

Streaming

Kun stream agordita al true la respondo alvenas kiel eventoj chat.completion.chunk kaj finiĝas per data: [DONE]. La lasta peco antaŭ ĝi portas finish_reason kaj usage; neniuj stream_options estas necesaj. La formoj de pecoj, linioj keep-alive kaj eraroj en fluo havas sian propran paĝon. Fluigo

Eraroj

Eraro estas JSON-objekto kun membro error. La kontroloj okazas en ĉi tiu ordo: API-ŝlosilo, petkorpo, modelo-id, poste saldo. La tabelo listigas tion, kion ĉi tiu endpoint plej ofte redonas. La plena listo, kun indiko kiam reprovi, havas sian propran paĝon. Erarotraktado

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