Quaestus interretialis

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

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": "What is the weather forecast for Lisbon this weekend?"}],
    extra_body={"web_search": True},  # a Shannon field, so it goes in extra_body
)

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: "What is the weather forecast for Lisbon this weekend?" }],
  web_search: true,
});

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": "What is the weather forecast for Lisbon this weekend?"}
    ],
    "web_search": true
  }'

Responsio est chat completion ordinaria cum duobus additamentis. Responsum ad eventus quaestus numeris in uncis quadratis monstrat, sources dicit quid quisque numerus significet, et annotations notat ubi quisque citetur:

{
  "id": "chatcmpl-3e5a7c9b1d2f4a6c8e0b2d4f6a8c1e3b",
  "object": "chat.completion",
  "created": 1791590400,
  "model": "shannon-3",
  "choices": [
    {
      "index": 0,
      "message": {
        "role": "assistant",
        "content": "Saturday in Lisbon is forecast to be sunny with a high near 24 °C [1]. Sunday turns cloudy, with a chance of light rain in the afternoon [2].",
        "reasoning_content": null,
        "annotations": [
          {
            "type": "url_citation",
            "url_citation": {
              "start_index": 66,
              "end_index": 69,
              "url": "https://weather.example/lisbon/weekend",
              "title": "Lisbon weather: weekend outlook"
            }
          },
          {
            "type": "url_citation",
            "url_citation": {
              "start_index": 137,
              "end_index": 140,
              "url": "https://forecast.example/pt/lisbon/sunday",
              "title": "Sunday forecast for Lisbon"
            }
          }
        ]
      },
      "finish_reason": "stop"
    }
  ],
  "usage": {
    "prompt_tokens": 2874,
    "completion_tokens": 41,
    "total_tokens": 2915
  },
  "sources": [
    {
      "index": 1,
      "title": "Lisbon weather: weekend outlook",
      "url": "https://weather.example/lisbon/weekend"
    },
    {
      "index": 2,
      "title": "Sunday forecast for Lisbon",
      "url": "https://forecast.example/pt/lisbon/sunday"
    },
    {
      "index": 3,
      "title": "Portugal: the week ahead",
      "url": "https://news.example/portugal/weather-week"
    }
  ]
}

Quaestum activare

Quaestus est campus petitionis, defaulto extinctus. Nihil quaeritur nisi petitio eum mittit.

In /v1/messages campus in gradu summo corporis sedet, iuxta model et messages:

{
  "model": "shannon-3",
  "web_search": true,
  "messages": [
    {
      "role": "user",
      "content": "What is the weather forecast for Lisbon this weekend?"
    }
  ]
}

Quid petitio cum quaestu faciat

• API interretem pro ultimo nuntio user quaerit. Turni priores conversationis quaestui contextum dant.
• Quaestus in omni petitione currit quae web_search: true mittit. Modellum non eligit num quaerat.
• Eventus ante modellum ut fontes numerati ponuntur, et modellum responsionem suam ex iis scribit.
• Responsio incipit cum quaestus factus est. Petitio streamed nihil mittit, neque headers neque eventus, usque tunc, itaque exspectationem longiorem ante primum chunk praevide.

Quid responsio contineat

• Responsio formam solitam sui endpoint habet. Responsio est in choices[0].message.content (block text in /v1/messages).
• Textus notas ut [1] et [2] post enuntiata quae sustinent ferre potest. Quisque numerus pro uno ex eventibus quos modellum legit stat.
• sources eos eventus nominat: unum ingressum pro quoque eventu qui modello datus est, cum index, title et url. Nota [1] est ingressus cum index 1. Eventus quos responsum non citat etiam in indice sunt.
• In /v1/chat/completions nuntius etiam annotations habet, forma OpenAI: unum url_citation pro quoque fonte quem nota nominat, cum url, title, et start_index et end_index, positio notae in content characteribus numerata (finis non includitur).
• In stream sources cum ultimo chunk venit, et in /v1/messages cum eventu message_delta. Adnotationes in uno chunk paulo ante ultimum veniunt, ut delta.annotations.
• sources adest solum cum quaestus huius petitionis aliquid invenit. Responsio sine eo sine eventibus quaestus scripta est.

Quomodo quaestus computentur

Quodque planum numerum quaestuum per diem includit:

• Petitio cuius quaestus aliquid invenit unum quaestum ex quota diei consumit. Quaestus qui nihil invenit nullum consumit.
• Chat et API quotam rationis quae clavem possidet communicant.
• Numeratio cotidie ad 00:00 UTC iterum incipit.
• Eventus quaestus sunt tokens input petitionis et cum reliquo prompt computantur.

Plana compara

Cum quaestus diei consumpti sunt

Petitio quae web_search: true post ultimum quaestum diei mittit non recusatur. Sine quaestu respondetur: status est 200 et responsio sources non habet.

Quaestus ut tool proprium

web_search: true est solus commutator quaestus hic descripti. Functio quam in tools definis et web_search nominas est unum e tools tuis: modellum vocationem reddit, et codex tuus quaestum agit et eventum remittit.

Typi tool quaestus aliarum platformarum, ut web_search_20250305 in /v1/messages vel {"type": "web_search"} in /v1/responses, hic quaestum non incipiunt.

Errores

Quaestus interretialis nullum codicem status nec typum erroris addit. Quaestus qui nihil invenit, aut dies sine quaestibus reliquis, responsionem normalem sine eventibus quaestus dat. Omnis alius error idem est ac pro petitione sine quaestu. Tractatio errorum