Chat Completions
POST /v1/chat/completions colloquium accipit et nuntium modelli proximum in forma OpenAI Chat Completions reddit. Ex quovis SDK OpenAI vel per HTTP simplicem utere; haec pagina est referentia campus per campum.
POST https://api.shannon-ai.com/v1/chat/completions
Petitio minima est id modelli et unus nuntius utentis.
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."}]
}' Responsum est unum objectum 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
}
} Headers
Headers petitionis
| Header | Valor | Descriptio |
|---|---|---|
Authorization | Bearer YOUR_API_KEY | Clavis tua API. x-api-key: YOUR_API_KEY pro ea in omni endpoint accipitur. |
Content-Type | application/json | Requisitum. Quivis alius valor 415 reddit. |
x-request-id | Facultativum. Id tuum proprium pro petitione. In responso immutatum redit. |
Headers responsi
| Header | Descriptio |
|---|---|
x-request-id | In omni responso, erroribus et fluxibus inclusis: valor quem misisti, vel 12 characteres hexadecimales cum nullum misisti. Eum cita cum problema nuntias. |
content-type | application/json, vel text/event-stream cum stream est true. |
Campi petitionis
Solum messages requiritur. Columna Applicatur a modella nominat in quibus campus responsum mutat. Modella open-weight hospitata sunt duodecim ids indicis modellorum; familia Shannon 3 est shannon-3, shannon-3-pro, shannon-3.1 et shannon-3.1-pro. Modella et pretia
| Campus | Genus | Default | Descriptio | Applicatur a |
|---|---|---|---|---|
model | string | shannon-1.6-lite | Modellum quod respondet: id ex indice modellorum. Cum omni petitione mitte. Comparatio maiusculas minusculasque non distinguit. Id quod publicatum non est 400 unknown model reddit. | Omnia modella |
messages | array | Requisitum. Colloquium, nuntio vetustissimo primo. Vide Nuntii infra. | Omnia modella | |
stream | boolean | false | true responsum ut server-sent events mittit dum scribitur. | Omnia modella |
max_tokens | integer | 4096 | Limes superior responsi, in tokens. Valor extra 1 ad 65,536 in illam seriem adducitur. Est etiam quantitas quae a saldo tuo reservatur dum petitio currit. Vide Longitudo outputi infra. | Modella open-weight hospitata, shannon-1.6-lite, shannon-1.6-pro, shannon-coder-1 |
max_completion_tokens | integer | Idem ac max_tokens. Cum ambo mittuntur, max_tokens adhibetur. | Modella open-weight hospitata, shannon-1.6-lite, shannon-1.6-pro, shannon-coder-1 | |
temperature | number | Temperatura sampling. In modellis open-weight hospitatis default est 1 et valores inter 0 et 2 servantur. | Modella open-weight hospitata, shannon-1.6-lite, shannon-1.6-pro, shannon-coder-1 | |
top_p | number | 0.95 | Nucleus sampling. Valores inter 0 et 1 servantur. | Modella open-weight hospitata |
seed | integer | Semen sampleris, quivis integer. Sine eo semen ex modello et colloquio derivatur, itaque eadem petitio bis missa idem semen adhibet. | Modella open-weight hospitata | |
stop | string | array | Series litterarum vel ordo serierum. Usque ad 4 adhibentur. Responsum ante primam quae apparet finitur; textus stop ipse non redditur. | Modella open-weight hospitata | |
reasoning_effort | string | high | Quantum modellum ratiocinetur antequam respondeat: off, low, medium vel high. none et minimal significant off, default significat medium, max significat high. Quivis alius valor 400 reddit. | Modella open-weight hospitata |
reasoning | object | Idem statutum in forma objecti: {"effort": "low"}. Cum ambo mittuntur, reasoning_effort adhibetur. | Modella open-weight hospitata | |
tools | array | Functiones quas modellum vocare potest, quaeque ut {"type": "function", "function": {"name", "description", "parameters"}}. Vocationes modelli in tool_calls redeunt; codex tuus eas exsequitur. | Omnia modella | |
tool_choice | string | object | auto | "auto" modellum decernere sinit. "required" instrumentum vocare cogit. {"type": "function", "function": {"name": "…"}} illud instrumentum vocare cogit. | Modella open-weight hospitata |
response_format | object | {"type": "json_object"} pro responso JSON, vel {"type": "json_schema", "json_schema": {…}} pro responso quod schema tuum sequitur. | Omnes gradus Shannon; modella open-weight hospitata ut per id enumerantur | |
web_search | boolean | false | true modellum in interreti quaerere sinit antequam respondeat. | shannon-1.6-*, shannon-2-*, familia Shannon 3 |
Alii campi OpenAI, ut n, user, stream_options, parallel_tool_calls, presence_penalty, frequency_penalty, logit_bias, logprobs, metadata, store et prompt_cache_key, accipiuntur ut codex clientis existens immutatus currat. Responsum non mutant: semper una electio est, et fluxus semper cum usu finitur.
Campus cum genere JSON falso, exempli gratia "max_tokens": "100", 422 reddit. Petitio sine messages idem facit.
Instrumenta, output structus, ratiocinatio et quaestus interretialis paginam propriam quaeque habent: Vocatio functionum, Exitus structi, Conatus ratiocinationis, Quaestus interretialis.
Petitio cum optionibus
Haec petitio nuntium system, campos sampling et conatum ratiocinationis statuit. Modellum open-weight hospitatum utitur, quod omnia applicat.
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"
}' Responsum eandem formam habet ac supra. Eius usage in modellis open-weight hospitatis duo singula addit: tokens prompti e cache lectos et tokens in ratiocinationem impensos.
{
"usage": {
"prompt_tokens": 31,
"completion_tokens": 62,
"total_tokens": 93,
"prompt_tokens_details": {
"cached_tokens": 0
},
"completion_tokens_details": {
"reasoning_tokens": 21
}
}
} Longitudo outputi
max_tokens duo facit. Primum, est numerus tokenorum qui a saldo tuo reservatur cum petitio incipit. Cum responsum completum est, haec quantitas tokens quibus petitio usa est substituitur. Si max_tokens maius est quam quod de saldo tuo superest, petitio 429 Quota exceeded reddit etiam si responsum ipsum capi potuisset. max_tokens inferius mitte ut minus reserves.
shannon-coder-1 in hoc endpoint aliter computatur: quaeque petitio est una ex vocationibus Shannon Coder plani tui, et nulli tokens pro ea reservantur. Limites et saldum
Secundum, longitudinem responsi in his modellis limitat:
| Modella | Quid max_tokens faciat |
|---|---|
shannon-1.6-lite, shannon-1.6-pro, shannon-coder-1 | Responsum sistit cum limitem attingit. Fluxus tum cum finish_reason length finitur. |
| Modella open-weight hospitata | Textus responsi ad max_tokens sistit. Ratiocinatio contra id non computatur. Valores infra 256 ut 256 agunt. |
Sine max_tokens vel max_completion_tokens valor est 4,096. In shannon-coder-1 est 65,536.
Nuntii
Quisque nuntius est objectum cum role et content. content est series litterarum, vel ordo partium cum nuntius plus quam textum fert.
| Munus | Descriptio | Applicatur a |
|---|---|---|
system | Instructiones pro modello. Primum pone. In gradibus Shannon primus nuntius system is est qui adhibetur. | Modella open-weight hospitata, shannon-1.6-*, shannon-2-*, shannon-coder-1 |
developer | Ut system legitur. | Modella open-weight hospitata |
user | Quod rogas. In gradibus Shannon ultimus nuntius user est promptum et nuntii ante eum sunt historia. | Omnia modella |
assistant | Responsa priora modelli. tool_calls eius retine cum exitum instrumenti post eum mittis. | Omnia modella |
tool | Exitus vocationis instrumenti: tool_call_id id vocationis tenet et content exitum ut seriem litterarum. | Omnia modella |
Cum id familiae Shannon 3, instructiones quae valere debent in nuntium user pone.
In gradibus Shannon petitio sine textu utentis et sine tools 400 No user message provided reddit.
Partes contenti
| Pars | Descriptio | Praesto in |
|---|---|---|
{"type": "text", "text": "…"} | Textus simplex. | Omnia modella |
{"type": "image_url", "image_url": {"url": "…"}} | Imago, ut URL data: cum contento base64 vel ut URL http(s). | Familia Shannon 3, shannon-1.6-lite, shannon-1.6-pro et modella open-weight hospitata quae imaginem ut input enumerant |
{"type": "file", "source": {"type": "base64", "media_type": "application/pdf", "data": "…"}} | Documentum (PDF, Word, PowerPoint vel Excel), ut base64 vel per URL. | Familia Shannon 3 |
Magnitudines, limites et index plenus formarum paginam propriam habent. Imagines et fasciculi
Objectum responsi
| Campus | Genus | Descriptio |
|---|---|---|
id | string | chatcmpl- quod sequuntur 32 characteres hexadecimales. |
object | string | Semper chat.completion. |
created | integer | Tempus responsi, in secundis Unix. |
model | string | Id canonicum modelli quod respondit. Orthographia ab id quod misisti differre potest. |
choices | array | Semper exacte una electio, cum index 0. |
choices[0].message.role | string | Semper assistant. |
choices[0].message.content | string | null | Textus responsi. Cum tool_calls in gradibus Shannon est null; modella open-weight hospitata textum iuxta vocationes mittere possunt. |
choices[0].message.reasoning_content | string | null | Ratiocinatio quam modellum ante responsum scripsit, vel null cum nulla est. |
choices[0].message.tool_calls | array | Solum adest cum modellum instrumenta vocat. Quisque introitus id, type function, et function cum name et arguments ut serie JSON habet. |
choices[0].message.annotations | array | Solum in petitione cum web_search: true cuius quaestus aliquid invenit. Unum url_citation pro quoque fonte quem nota in content nominat, cum url, title, start_index et end_index (positio notae, characteribus numerata, finis non includitur). |
choices[0].finish_reason | string | Cur responsum finitum sit. Vide Causae finis. |
usage | object | Tokens petitionis. Vide Usus. |
sources | array | Solum in petitione cum web_search: true cuius quaestus aliquid invenit: eventus qui modello dati sunt, quisque cum index, title et url. [1] in responso est ingressus cum index 1. |
Causae finis
| finish_reason | Descriptio |
|---|---|
stop | Modellum responsum finivit, vel series stop apparuit. |
tool_calls | Modellum unum vel plura instrumenta vocat. Exsequere ea et exitus in nuntiis tool mitte. |
length | Responsum ad limitem outputi abscissum est. In fluxibus shannon-1.6-lite, shannon-1.6-pro, shannon-coder-1 et familiae Shannon 3 nuntiatur. |
Responsum non per fluxum missum stop vel tool_calls nuntiat.
Usus
| Campus | Genus | Descriptio | Praesto in |
|---|---|---|---|
usage.prompt_tokens | integer | Tokens inputi. | Omnia modella |
usage.completion_tokens | integer | Tokens outputi: ratiocinatio, responsum et vocationes instrumentorum simul. | Omnia modella |
usage.total_tokens | integer | prompt_tokens plus completion_tokens. | Omnia modella |
usage.prompt_tokens_details.cached_tokens | integer | Pars prompt_tokens quae e cache prompti lecta est. | Modella open-weight hospitata |
usage.completion_tokens_details.reasoning_tokens | integer | Pars completion_tokens quae in ratiocinationem impensa est. | Modella open-weight hospitata |
In modellis open-weight hospitatis, prompt_tokens sunt nuntii tui et definitiones instrumentorum cum tokenizer proprio modelli computati, plus tokens quarumlibet imaginum. Endpoints computationis tokenorum eundem numerum reddunt antequam mittis. Computatio tokenum
In gradibus Shannon, prompt_tokens omnia computat quae modellum legit ut responsum scriberet, itaque maior est quam textus nuntiorum tuorum solus.
Fluxus
Cum stream in true positum est, responsum ut eventus chat.completion.chunk advenit et cum data: [DONE] finitur. Ultimum chunk ante id finish_reason et usage fert; nulla stream_options necessaria sunt. Formae chunk, lineae keep-alive et errores intra fluxum paginam propriam habent. Fluens
Errores
Error est objectum JSON cum membro error. Inspectiones hoc ordine fiunt: clavis API, corpus petitionis, id modelli, deinde saldum. Tabula ea enumerat quae hoc endpoint saepissime reddit. Index plenus, cum notis quid iterandum sit, paginam propriam habet. Tractatio errorum
{
"error": {
"type": "invalid_request_error",
"message": "unknown model: no-such-model"
}
} | Status | Genus | Nuntius | Quando |
|---|---|---|---|
401 | authentication_error | Missing authenticationInvalid API key | Nulla clavis API missa est, vel clavis ignota aut revocata est. |
400 | invalid_request_error | unknown model: <id> | model non est id publicatum. |
400 | invalid_request_error | No user message provided | Gradus Shannon: petitio nullum textum utentis nec tools habet. |
400 | invalid_request_error | <id> does not accept image input | Pars imaginis ad modellum open-weight hospitatum missa est quod imaginem ut input non accipit. |
400 | invalid_request_error | <id> does not accept response_format | response_format ad modellum open-weight hospitatum sine output structo missum est. |
400 | invalid_request_error | unknown reasoning effort '<value>'; expected off, low, medium or high | reasoning_effort valorem extra indicem continet. |
422 | invalid_request_error | Failed to deserialize the JSON body into the target type: … | messages deest, vel campus genus JSON falsum habet. |
429 | rate_limit_error | Quota exceeded. Upgrade your plan at shannon-ai.com/plan | max_tokens maius est quam quod de saldo tuo superest. |
429 | rate_limit_error | Too many requests. Retry in <n>s. | Defensio inundationis: plus quam 120 petitiones uno minuto in ratione tua. |
500 | server_error | The model backend failed to answer. Please retry. | Modellum responsum non edidit. Petitionem iterum mitte. |
502 | api_error | The model backend failed to answer. Please retry. | Idem, in familia Shannon 3 et in modellis open-weight hospitatis. |