Chat Completions

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

Die kleinste versoek is 'n model-id en een gebruikersboodskap.

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

Die antwoord is een JSON-objek:

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

Headers

Versoek-headers

Antwoord-headers

Versoekvelde

Slegs messages is verpligtend. Die kolom Toegepas deur noem die modelle waarop 'n veld die antwoord verander. Die gehuisveste oopgewig-modelle is die twaalf id's van die modellys; die Shannon 3-familie is shannon-3, shannon-3-pro, shannon-3.1 en shannon-3.1-pro. Modelle en pryse

Ander OpenAI-velde, soos n, user, stream_options, parallel_tool_calls, presence_penalty, frequency_penalty, logit_bias, logprobs, metadata, store en prompt_cache_key, word aanvaar sodat bestaande kliëntkode ongewysig loop. Hulle verander nie die antwoord nie: daar is altyd een keuse, en 'n stroom eindig altyd met gebruik.

'n Veld met die verkeerde JSON-tipe, byvoorbeeld "max_tokens": "100", gee 422 terug. 'n Versoek sonder messages doen dit ook.

Gereedskap, gestruktureerde uitvoer, redenering en websoektog het elk hul eie bladsy: Funksie-oproepe, Gestruktureerde uitvoer, Redeneringspoging, Websoektog.

'n Versoek met opsies

Hierdie versoek stel 'n stelselboodskap, die steekproefvelde en die redeneringspoging. Dit gebruik 'n gehuisveste oopgewig-model, wat almal toepas.

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

Die antwoord het dieselfde vorm as hierbo. Sy usage voeg twee besonderhede by op die gehuisveste oopgewig-modelle: die prompt-tokens wat uit die kas gelees is en die tokens wat aan redenering bestee is.

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

Uitvoerlengte

max_tokens doen twee dinge. Eerstens is dit die aantal tokens wat van jou balans opsy gesit word wanneer die versoek begin. Wanneer die antwoord voltooi is, word daardie bedrag vervang deur die tokens wat die versoek gebruik het. As max_tokens groter is as wat van jou balans oor is, gee die versoek 429 Quota exceeded terug selfs wanneer die antwoord self gepas het. Stuur 'n laer max_tokens om minder opsy te sit.

shannon-coder-1 word op hierdie eindpunt anders getel: elke versoek is een van jou plan se Shannon Coder-oproepe, en geen tokens word daarvoor opsy gesit nie. Perke en balans

Tweedens beperk dit die lengte van die antwoord op hierdie modelle:

Sonder max_tokens of max_completion_tokens is die waarde 4,096. Op shannon-coder-1 is dit 65,536.

Boodskappe

Elke boodskap is 'n objek met 'n role en 'n content. content is 'n string, of 'n skikking van dele wanneer die boodskap meer as teks dra.

Met 'n Shannon 3-familie-id, sit instruksies wat moet geld in die user-boodskap.

Op die Shannon-vlakke gee 'n versoek sonder gebruikersteks en sonder tools 400 No user message provided terug.

Inhouddele

Groottes, limiete en die volledige lys vorme het hul eie bladsy. Beelde en lêers

Die antwoordobjek

Eindredes

'n Antwoord wat nie gestroom word nie, rapporteer stop of tool_calls.

Gebruik

Op die gehuisveste oopgewig-modelle is prompt_tokens jou boodskappe en gereedskapdefinisies getel met die model se eie tokeniseerder, plus die tokens van enige beelde. Die tokentel-eindpunte gee dieselfde getal terug voordat jy stuur. Tokens tel

Op die Shannon-vlakke tel prompt_tokens alles wat die model gelees het om die antwoord te skryf, so dit is groter as die teks van jou boodskappe alleen.

Streaming

Met stream op true kom die antwoord aan as chat.completion.chunk-gebeurtenisse en eindig met data: [DONE]. Die laaste brokkie daarvoor dra finish_reason en usage; geen stream_options is nodig nie. Die brokkievorme, keep-alive-reëls en foute binne 'n stroom het hul eie bladsy. Stroming

Foute

'n Fout is 'n JSON-objek met 'n error-lid. Kontroles loop in hierdie volgorde: API-sleutel, versoekliggaam, model-id, dan balans. Die tabel lys wat hierdie eindpunt die meeste teruggee. Die volledige lys, met wat om weer te probeer, het sy eie bladsy. Fouthantering

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