Responses API

POST https://api.shannon-ai.com/v1/responses

Най-малката заявка е id на модел и текст. Отговорът е без стрийминг, освен ако не го поискате.

from openai import OpenAI

client = OpenAI(
    api_key="YOUR_API_KEY",
    base_url="https://api.shannon-ai.com/v1",
)

response = client.responses.create(
    model="shannon-3",
    input="Say hello in one sentence.",
)

print(response.output_text)

import OpenAI from "openai";

const client = new OpenAI({
  apiKey: "YOUR_API_KEY",
  baseURL: "https://api.shannon-ai.com/v1",
});

const response = await client.responses.create({
  model: "shannon-3",
  input: "Say hello in one sentence.",
});

console.log(response.output_text);

curl https://api.shannon-ai.com/v1/responses \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "shannon-3",
    "input": "Say hello in one sentence."
  }'

Отговорът е обект на отговор. Неговото output съдържа разсъжденията, когато моделът е разсъждавал, и съобщението:

{
  "id": "resp_5f0c1e7a9b3d4c62a8e1f07d2b46c9a3",
  "object": "response",
  "created_at": 1791625200,
  "model": "shannon-3",
  "status": "completed",
  "error": null,
  "incomplete_details": null,
  "instructions": null,
  "metadata": {},
  "parallel_tool_calls": true,
  "temperature": null,
  "tool_choice": "auto",
  "tools": [],
  "top_p": null,
  "output": [
    {
      "id": "rs_8a2e6c1f4b7d4e03b9c5a1d70f3e2b64",
      "type": "reasoning",
      "summary": [
        {
          "type": "summary_text",
          "text": "The user wants a greeting in one sentence. Keep it short and friendly."
        }
      ]
    },
    {
      "id": "msg_1c7b9e3a5d2f4a86b0e4c8d19a6f7e25",
      "type": "message",
      "role": "assistant",
      "status": "completed",
      "content": [
        {
          "type": "output_text",
          "text": "Hello, it is good to meet you.",
          "annotations": []
        }
      ]
    }
  ],
  "usage": {
    "input_tokens": 1184,
    "output_tokens": 46,
    "total_tokens": 1230
  }
}

Полета на заявката

model и input са това, от което заявката се нуждае. Колоната Прилагано от назовава моделите, при които полето променя отговора. Хостваните open-weight модели са дванадесетте id-та от списъка с модели; семейството Shannon 3 е shannon-3, shannon-3-pro, shannon-3.1 и shannon-3.1-pro. Модели и цени

previous_response_id, store, metadata, parallel_tool_calls, truncation, include, user и prompt_cache_key се приемат, за да работи съществуващият клиентски код без промяна. Те не променят отговора. Тъй като разговор не се съхранява, последваща заявка носи по-ранните ходове в input.

Входни елементи

Входният елемент е или съобщение, с role и content, или типизиран елемент, който носи извикване на инструмент или неговия резултат. content е низ или масив от части.

Поставяйте инструкциите в полето instructions. При id от семейството Shannon 3 поставяйте инструкциите, които трябва да се спазват, в съобщението user.

Елементите на output на един отговор могат да се върнат в input такива, каквито са: елементите message и function_call се четат, елементите reasoning се пропускат.

Части на съдържанието

При нивата на Shannon изображенията и файловете се четат от последния елемент user на input. Размерите и ограниченията имат собствена страница. Изображения и файлове

Заявка с инструкции и опции

Тази заявка изпраща инструкции, разговор като входни елементи, ограничение на изхода, температура и усилия за разсъждения. Използва хостван open-weight модел, който прилага всичко това.

from openai import OpenAI

client = OpenAI(
    api_key="YOUR_API_KEY",
    base_url="https://api.shannon-ai.com/v1",
)

response = client.responses.create(
    model="DeepSeek-V4-Flash-0731-W4A16-AUTOROUND-REAP",
    instructions="You are a physics teacher. Answer in two sentences.",
    input=[
        {"role": "user", "content": "Why is the sky blue?"},
        {"role": "assistant", "content": "Air scatters blue light more than red light."},
        {"role": "user", "content": "And why are sunsets red?"},
    ],
    max_output_tokens=512,
    temperature=0.3,
    reasoning={"effort": "low"},
)

for item in response.output:
    if item.type == "reasoning":
        print("reasoning:", item.summary[0].text)
    elif item.type == "message":
        print("answer:", item.content[0].text)
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.responses.create({
  model: "DeepSeek-V4-Flash-0731-W4A16-AUTOROUND-REAP",
  instructions: "You are a physics teacher. Answer in two sentences.",
  input: [
    { role: "user", content: "Why is the sky blue?" },
    { role: "assistant", content: "Air scatters blue light more than red light." },
    { role: "user", content: "And why are sunsets red?" },
  ],
  max_output_tokens: 512,
  temperature: 0.3,
  reasoning: { effort: "low" },
});

for (const item of response.output) {
  if (item.type === "reasoning") console.log("reasoning:", item.summary[0].text);
  if (item.type === "message") console.log("answer:", item.content[0].text);
}
console.log(response.usage);

curl https://api.shannon-ai.com/v1/responses \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "DeepSeek-V4-Flash-0731-W4A16-AUTOROUND-REAP",
    "instructions": "You are a physics teacher. Answer in two sentences.",
    "input": [
      {"role": "user", "content": "Why is the sky blue?"},
      {"role": "assistant", "content": "Air scatters blue light more than red light."},
      {"role": "user", "content": "And why are sunsets red?"}
    ],
    "max_output_tokens": 512,
    "temperature": 0.3,
    "reasoning": {"effort": "low"}
  }'

Отговорът на хостван open-weight модел има id, object, model, created_at, status, output и usage. Неговото usage добавя токените, прочетени от кеша, и токените, изразходвани за разсъждения:

{
  "usage": {
    "input_tokens": 58,
    "input_tokens_details": {
      "cached_tokens": 0
    },
    "output_tokens": 67,
    "output_tokens_details": {
      "reasoning_tokens": 19
    },
    "total_tokens": 125
  }
}

Обектът на отговора

id, object, status, output и usage присъстват във всеки отговор. Изграждайте кода си върху тях.

Изходни елементи

SDK на OpenAI съединяват вместо Вас текста на съобщението в response.output_text.

Стрийминг

Задайте stream на true за server-sent events. Всеки кадър има ред event: с името на събитието и ред data: с JSON обект; обектът повтаря името в type. Съпоставяйте делтите с техния елемент по output_index.

Със SDK на OpenAI четете събитията по техния type:

from openai import OpenAI

client = OpenAI(
    api_key="YOUR_API_KEY",
    base_url="https://api.shannon-ai.com/v1",
)

stream = client.responses.create(
    model="shannon-3",
    input="Explain server-sent events in three sentences.",
    stream=True,
)

for event in stream:
    kind = getattr(event, "type", "error")     # an event without a type is an error event
    if kind == "response.reasoning_summary_text.delta":
        pass                                   # a piece of reasoning: event.delta
    elif kind == "response.output_text.delta":
        print(event.delta, end="", flush=True)
    elif kind == "response.output_item.done" and event.item.type == "function_call":
        print("\ntool call:", event.item.name, event.item.arguments)
    elif kind == "response.completed":
        print("\n", event.response.usage)
    elif kind in ("response.failed", "error"):
        raise RuntimeError("the stream failed, send the request again")

import OpenAI from "openai";

const client = new OpenAI({
  apiKey: "YOUR_API_KEY",
  baseURL: "https://api.shannon-ai.com/v1",
});

const stream = await client.responses.create({
  model: "shannon-3",
  input: "Explain server-sent events in three sentences.",
  stream: true,
});

for await (const event of stream) {
  if (event.type === "response.reasoning_summary_text.delta") {
    // a piece of reasoning: event.delta
  } else if (event.type === "response.output_text.delta") {
    process.stdout.write(event.delta);
  } else if (event.type === "response.output_item.done" && event.item.type === "function_call") {
    console.log("\ntool call:", event.item.name, event.item.arguments);
  } else if (event.type === "response.completed") {
    console.log("\n", event.response.usage);
  } else if (event.type === "response.failed" || event.type === "error") {
    throw new Error("the stream failed, send the request again");
  }
}

curl -N https://api.shannon-ai.com/v1/responses \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "shannon-3",
    "input": "Explain server-sent events in three sentences.",
    "stream": true
  }'

Събитията пристигат в този ред. Групите за разсъждения, съобщението и извикванията на инструменти се появяват само когато отговорът ги има.

event: response.created
data: {"type":"response.created","response":{"id":"resp_5f0c…","object":"response","status":"in_progress","output":[], …}}

event: response.in_progress
data: {"type":"response.in_progress","response":{"id":"resp_5f0c…","object":"response","status":"in_progress","output":[], …}}

event: response.output_item.added
data: {"type":"response.output_item.added","output_index":0,"item":{"id":"msg_1c7b…","type":"message","role":"assistant","status":"in_progress","content":[]}}

event: response.content_part.added
data: {"type":"response.content_part.added","output_index":0,"content_index":0,"part":{"type":"output_text","text":""}}

event: response.output_text.delta
data: {"type":"response.output_text.delta","output_index":0,"content_index":0,"delta":"Server-sent"}

event: response.output_text.delta
data: {"type":"response.output_text.delta","output_index":0,"content_index":0,"delta":" events let a server push text over one HTTP reply."}

event: response.output_text.done
data: {"type":"response.output_text.done","output_index":0,"content_index":0,"text":"Server-sent events let a server push text over one HTTP reply."}

event: response.content_part.done
data: {"type":"response.content_part.done","output_index":0,"content_index":0,"part":{"type":"output_text","text":"Server-sent events let a server push text over one HTTP reply."}}

event: response.output_item.done
data: {"type":"response.output_item.done","output_index":0,"item":{"id":"msg_1c7b…","type":"message","role":"assistant","status":"completed","content":[{"type":"output_text","text":"Server-sent events let a server push text over one HTTP reply.","annotations":[]}]}}

event: response.completed
data: {"type":"response.completed","response":{"id":"resp_5f0c…","object":"response","status":"completed","output":[…],"usage":{"input_tokens":1190,"output_tokens":18,"total_tokens":1208}, …}}

Стрийм, който се проваля

При нивата на Shannon неуспешният отговор завършва с response.failed вместо response.completed. Неговото response.status е failed, а response.error съдържа code, rate_limit_exceeded или server_error, и message.

При хостваните open-weight модели неуспехът е събитие error с code api_error и message. След него все пак следва response.completed.

Смятайте стрийма за неуспешен, когато съдържа събитие response.failed или error, и изпратете заявката отново.

Инструменти

Инструментът е функция, която Вашият код изпълнява. Опишете го в tools; когато моделът го поиска, отговорът съдържа елемент function_call вместо съобщението или до него.

Дефиниция на инструмент в tools:

[
  {
    "type": "function",
    "name": "get_weather",
    "description": "Current weather for a city.",
    "parameters": {
      "type": "object",
      "properties": {
        "city": {
          "type": "string"
        }
      },
      "required": [
        "city"
      ]
    }
  }
]

output на отговор, който го извиква:

[
  {
    "id": "call_3d9a7c1e5b2f4a60c8e1d7f09b24a6c5",
    "type": "function_call",
    "name": "get_weather",
    "call_id": "call_3d9a7c1e5b2f4a60c8e1d7f09b24a6c5",
    "arguments": "{\"city\":\"Paris\"}"
  }
]

Изпълнете функцията, после изпратете заявката отново с добавени към input извикването и неговия резултат:

[
  {
    "role": "user",
    "content": "What is the weather in Paris?"
  },
  {
    "type": "function_call",
    "call_id": "call_3d9a7c1e5b2f4a60c8e1d7f09b24a6c5",
    "name": "get_weather",
    "arguments": "{\"city\":\"Paris\"}"
  },
  {
    "type": "function_call_output",
    "call_id": "call_3d9a7c1e5b2f4a60c8e1d7f09b24a6c5",
    "output": "{\"temperature_c\": 18, \"sky\": \"cloudy\"}"
  }
]

Четат се само инструменти от тип function. При shannon-1.6-*, shannon-2-* и shannon-coder-1 схемата parameters се свежда до общите ключови думи на JSON Schema: oneOf се чете като anyOf, а ключови думи като $ref, additionalProperties, const, default и title не се предават на модела.

Стойностите на tool_choice required и именувана функция се прилагат от хостваните open-weight модели.

Цикълът на инструментите е описан изцяло на собствена страница. Извикване на функции

Структуриран изход

Този формат изписва структурирания изход като text.format. Схемата стои директно в format, до name и strict, а не под член json_schema, както при Chat Completions.

• {"type": "json_object"} иска произволен JSON обект.
• {"type": "json_schema", "name", "schema", "strict"} иска JSON, който следва Вашата схема. strict е true, когато го пропуснете.

{
  "model": "shannon-1.6-lite",
  "input": "Extract the city and the date: 'The conference opens in Lisbon on 12 May 2027.'",
  "text": {
    "format": {
      "type": "json_schema",
      "name": "event",
      "strict": true,
      "schema": {
        "type": "object",
        "properties": {
          "city": {
            "type": "string"
          },
          "date": {
            "type": "string",
            "description": "ISO 8601 date"
          }
        },
        "required": [
          "city",
          "date"
        ]
      }
    }
  }
}

JSON пристига като текст в частта output_text на съобщението; парсирайте го сами. Хостван open-weight модел без структуриран изход връща 400.

{"city": "Lisbon", "date": "2027-05-12"}

Кой модел приема коя форма е изброено на собствена страница. Структурирани изходи

Разсъждения

Модел, който разсъждава, връща разсъжденията си като изходен елемент от тип reasoning, преди съобщението. При стрийм те пристигат като събития response.reasoning_summary_text.delta.

Хостваните open-weight модели прилагат reasoning.effort: off, low, medium или high, като high, когато не изпратите нищо. off не връща елемент за разсъждения. Изпращайте го като обект; голям низ не се чете на този ендпоинт.

Усилията са описани на собствена страница. Усилие за разсъждение

Ограничение на изхода

max_output_tokens е 4,096, когато не го изпратите. Това е броят токени, отделени от баланса Ви при началото на заявката; когато отговорът е завършен, тази сума се заменя с това, което заявката е използвала. Стойност, която не се побира в оставащия Ви баланс, връща 429 Quota exceeded.

Ограничава дължината на отговора при shannon-1.6-*, shannon-2-* и shannon-coder-1, а при хостваните open-weight модели дължината на текста на отговора.

На този ендпоинт shannon-coder-1 се таксува в токени от баланса Ви, като всеки друг модел.

Тялото на заявката може да е до 32 MiB. Ограничения и баланс

Грешки

Грешките използват тялото на грешка на OpenAI: обект error с type и message; някои носят и code и param със стойност null. Таблицата изброява какво този ендпоинт връща най-често. Пълният списък, с това кое да се опита отново, има собствена страница. Обработка на грешки