Документація Shannon AI API

Огляд

Публічна документація

Усе, що потрібно для запуску з API Shannon, сумісною з OpenAI та Anthropic.

Базовий URL Сумісний з OpenAI

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

Використовуйте Chat Completions API з викликом функцій і стрімінгом.

Базовий URL Сумісний з Anthropic

https://api.shannon-ai.com/v1/messages

Формат Claude Messages з інструментами та заголовком anthropic-version.

Заголовки Автентифікація

Авторизація: Bearer <ваш-ключ>

Або X-API-Key з anthropic-version для викликів у стилі Claude.

Доступ Статус

Публічні документи — потрібен ключ для виклику

Стрімінг, виклик функцій, структуровані виходи, веб-пошук.

Чекліст запуску

+

Спрямуйте SDK на Shannon

Встановіть baseURL на OpenAI або Anthropic endpoints вище.

Налаштування
+

Додайте ваш API ключ

Використовуйте Bearer токени для OpenAI або X-API-Key + anthropic-version.

Безпека
+

Увімкніть інструменти та структуровані виходи

Підтримує OpenAI tools/functions, JSON schema та вбудований web_search.

Можливості
+

Відстежуйте використання

Переглядайте споживання токенів і пошуку на цій сторінці, коли ви увійшли.

Аналітика

Можливості

OpenAI + Anthropic

Drop‑in заміна для OpenAI та Anthropic APIs з нативною підтримкою інструментів, структурованих виходів і вбудованого веб‑пошуку.

Drop‑in заміна

Сумісний

Працює з OpenAI та Anthropic SDKs. Просто змініть base URL.

Виклик функцій

Інструменти

Визначайте інструменти, Shannon їх викликає. Підтримує auto, forced та none режими.

Вбудований веб‑пошук

Пошук

Веб‑пошук у реальному часі з цитатами джерел. Автоматично доступний.

Структуровані виходи

JSON

Режим JSON і примусове JSON Schema для надійного вилучення даних.

Багатоходові інструменти

Агентні

Автоматичні цикли виконання функцій. До 10 ітерацій на запит.

Стрімінг

Швидко

Server‑Sent Events для стрімінгу токенів у реальному часі.

Швидкий старт

5 хвилин

Почніть за три кроки. Shannon відтворює клієнти OpenAI та Anthropic.

Встановіть base URL

Використовуйте OpenAI‑сумісний endpoint.

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

Додайте ваш API ключ

Використовуйте Bearer auth у заголовку Authorization.

Надішліть перше повідомлення

Оберіть мову та підставте ваш ключ.

Python

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-1.6-lite",
    messages=[
        {"role": "system", "content": "You are a helpful assistant."},
        {"role": "user", "content": "Hello, Shannon!"}
    ],
    max_tokens=1024
)

print(response.choices[0].message.content)

JavaScript

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-1.6-lite',
  messages: [
    { role: 'system', content: 'You are a helpful assistant.' },
    { role: 'user', content: 'Hello, Shannon!' }
  ],
  max_tokens: 1024
});

console.log(response.choices[0].message.content);

package main

import (
    "context"
    "fmt"
    openai "github.com/sashabaranov/go-openai"
)

func main() {
    config := openai.DefaultConfig("YOUR_API_KEY")
    config.BaseURL = "https://api.shannon-ai.com/v1"
    client := openai.NewClientWithConfig(config)

    resp, err := client.CreateChatCompletion(
        context.Background(),
        openai.ChatCompletionRequest{
            Model: "shannon-1.6-lite",
            Messages: []openai.ChatCompletionMessage{
                {Role: "system", Content: "You are a helpful assistant."},
                {Role: "user", Content: "Hello, Shannon!"},
            },
            MaxTokens: 1024,
        },
    )
    if err != nil {
        panic(err)
    }
    fmt.Println(resp.Choices[0].Message.Content)
}

cURL

curl -X POST "https://api.shannon-ai.com/v1/chat/completions" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "shannon-1.6-lite",
    "messages": [
      {"role": "system", "content": "You are a helpful assistant."},
      {"role": "user", "content": "Hello, Shannon!"}
    ],
    "max_tokens": 1024
  }'

Формат відповіді

Успішна відповідь

{
  "id": "chatcmpl-abc123",
  "object": "chat.completion",
  "created": 1234567890,
  "model": "Shannon 1.6 Lite",
  "choices": [
    {
      "index": 0,
      "message": {
        "role": "assistant",
        "content": "Hello! I'm Shannon, your AI assistant. How can I help you today?"
      },
      "finish_reason": "stop"
    }
  ],
  "usage": {
    "prompt_tokens": 25,
    "completion_tokens": 18,
    "total_tokens": 43
  }
}

Playground

Нове

Тестуйте API Shannon прямо у браузері. Створіть запит, запустіть і побачте відповідь у реальному часі.

Chat, Responses, Messages

Switch across OpenAI Chat Completions, Responses, and Anthropic Messages without leaving the playground.

Stream live output

Run real requests, inspect raw JSON, and view stream events from the same operator console.

Reuse your key

Signed-in users can pull their Shannon API key straight into the dedicated playground workspace.

/uk/docs/playground

The playground now lives on its own route so the API docs stay Astro-rendered while the request builder remains an explicitly interactive client tool.

Спробувати Playground V2 Отримати API‑ключ

Аутентифікація

Усі API‑запити потребують автентифікації за допомогою вашого Shannon API ключа.

Формат OpenAI (рекомендовано)

HTTP

Authorization: Bearer YOUR_API_KEY

Формат Anthropic

HTTP

X-API-Key: YOUR_API_KEY
anthropic-version: 2023-06-01

Моделі

Shannon пропонує кілька моделей, оптимізованих для різних сценаріїв використання.

shannon-1.6-lite Shannon 1.6 Lite

Швидкі, ефективні відповіді для щоденних задач

Контекст 128K

Найкраще для Чат, Q&A, генерація контенту

shannon-1.6-pro Shannon 1.6 Pro

Просунуті міркування для складних проблем

Контекст 128K

Найкраще для Аналіз, дослідження, складні задачі

shannon-2-lite Shannon 2 Lite

Контекст 128K

Найкраще для

shannon-2-pro Shannon 2 Pro

Контекст 128K

Найкраще для

shannon-coder-1 Shannon Coder

Оптимізовано для Claude Code CLI з квотою на виклики

Контекст 128K

Найкраще для Генерація коду, використання інструментів, інтеграція CLI

Квота на виклики

Виклик функцій

Визначайте інструменти, які Shannon може викликати для виконання дій або отримання інформації.

Python

from openai import OpenAI
import json

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

# Define available tools/functions
tools = [
    {
        "type": "function",
        "function": {
            "name": "get_weather",
            "description": "Get current weather for a location",
            "parameters": {
                "type": "object",
                "properties": {
                    "location": {
                        "type": "string",
                        "description": "City name, e.g., 'Tokyo'"
                    },
                    "unit": {
                        "type": "string",
                        "enum": ["celsius", "fahrenheit"]
                    }
                },
                "required": ["location"]
            }
        }
    }
]

response = client.chat.completions.create(
    model="shannon-1.6-lite",
    messages=[{"role": "user", "content": "What's the weather in Tokyo?"}],
    tools=tools,
    tool_choice="auto"
)

# Check if model wants to call a function
if response.choices[0].message.tool_calls:
    tool_call = response.choices[0].message.tool_calls[0]
    print(f"Function: {tool_call.function.name}")
    print(f"Arguments: {tool_call.function.arguments}")

JavaScript

import OpenAI from 'openai';

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

const tools = [
  {
    type: 'function',
    function: {
      name: 'get_weather',
      description: 'Get current weather for a location',
      parameters: {
        type: 'object',
        properties: {
          location: { type: 'string', description: "City name" },
          unit: { type: 'string', enum: ['celsius', 'fahrenheit'] }
        },
        required: ['location']
      }
    }
  }
];

const response = await client.chat.completions.create({
  model: 'shannon-1.6-lite',
  messages: [{ role: 'user', content: "What's the weather in Tokyo?" }],
  tools,
  tool_choice: 'auto'
});

if (response.choices[0].message.tool_calls) {
  const toolCall = response.choices[0].message.tool_calls[0];
  console.log('Function:', toolCall.function.name);
  console.log('Arguments:', toolCall.function.arguments);
}

Опції вибору інструментів

"auto" Модель вирішує, чи викликати функцію (за замовчуванням)

"none" Вимкнути виклик функцій для цього запиту

{"type": "function", "function": {"name": "..."}} Примусово викликати конкретну функцію

Відповідь Function Call

Коли модель викликає функцію

{
  "id": "chatcmpl-xyz",
  "choices": [
    {
      "index": 0,
      "message": {
        "role": "assistant",
        "content": null,
        "tool_calls": [
          {
            "id": "call_abc123",
            "type": "function",
            "function": {
              "name": "get_weather",
              "arguments": "{\"location\": \"Tokyo\", \"unit\": \"celsius\"}"
            }
          }
        ]
      },
      "finish_reason": "tool_calls"
    }
  ]
}

Структуровані відповіді

Змусьте Shannon відповідати валідним JSON, що відповідає вашій схемі.

Python

from openai import OpenAI

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

# Force JSON output with schema
response = client.chat.completions.create(
    model="shannon-1.6-lite",
    messages=[
        {"role": "user", "content": "Extract: John Doe, 30 years old, engineer"}
    ],
    response_format={
        "type": "json_schema",
        "json_schema": {
            "name": "person_info",
            "schema": {
                "type": "object",
                "properties": {
                    "name": {"type": "string"},
                    "age": {"type": "integer"},
                    "occupation": {"type": "string"}
                },
                "required": ["name", "age", "occupation"]
            }
        }
    }
)

import json
data = json.loads(response.choices[0].message.content)
print(data)  # {"name": "John Doe", "age": 30, "occupation": "engineer"}

JavaScript

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-1.6-lite',
  messages: [
    { role: 'user', content: 'Extract: John Doe, 30 years old, engineer' }
  ],
  response_format: {
    type: 'json_schema',
    json_schema: {
      name: 'person_info',
      schema: {
        type: 'object',
        properties: {
          name: { type: 'string' },
          age: { type: 'integer' },
          occupation: { type: 'string' }
        },
        required: ['name', 'age', 'occupation']
      }
    }
  }
});

const data = JSON.parse(response.choices[0].message.content);
console.log(data); // { name: "John Doe", age: 30, occupation: "engineer" }

Опції формату відповіді

{"type": "json_object"} Примусово валідний JSON (без конкретної схеми)

{"type": "json_schema", "json_schema": {...}} Примусово вихід, що відповідає вашій схемі

Стримінг

Увімкніть стрімінг токенів у реальному часі через Server‑Sent Events для чуйних UI.

Python

from openai import OpenAI

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

# Enable streaming for real-time responses
stream = client.chat.completions.create(
    model="shannon-1.6-lite",
    messages=[
        {"role": "user", "content": "Write a short poem about AI"}
    ],
    stream=True
)

for chunk in stream:
    if chunk.choices[0].delta.content:
        print(chunk.choices[0].delta.content, end="", flush=True)

JavaScript

import OpenAI from 'openai';

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

// Enable streaming for real-time responses
const stream = await client.chat.completions.create({
  model: 'shannon-1.6-lite',
  messages: [
    { role: 'user', content: 'Write a short poem about AI' }
  ],
  stream: true
});

for await (const chunk of stream) {
  const content = chunk.choices[0]?.delta?.content;
  if (content) process.stdout.write(content);
}

Порада: Стрімінг відповіді надходять як Server‑Sent Events. Кожен chunk містить delta з частковим контентом.

Вбудований веб‑пошук

Shannon містить вбудовану функцію web_search, яка доступна автоматично.

Python

from openai import OpenAI

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

# Web search is automatically available!
# Shannon will use it when needed for current information

response = client.chat.completions.create(
    model="shannon-1.6-lite",
    messages=[
        {"role": "user", "content": "What are the latest AI news today?"}
    ],
    # Optionally, explicitly define web_search tool
    tools=[{
        "type": "function",
        "function": {
            "name": "web_search",
            "description": "Search the web for current information",
            "parameters": {
                "type": "object",
                "properties": {
                    "query": {"type": "string", "description": "Search query"}
                },
                "required": ["query"]
            }
        }
    }]
)

print(response.choices[0].message.content)
# Response includes sources and citations

JavaScript

import OpenAI from 'openai';

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

// Web search is automatically available!
// Shannon will use it when needed for current information

const response = await client.chat.completions.create({
  model: 'shannon-1.6-lite',
  messages: [
    { role: 'user', content: 'What are the latest AI news today?' }
  ],
  // Optionally, explicitly define web_search tool
  tools: [{
    type: 'function',
    function: {
      name: 'web_search',
      description: 'Search the web for current information',
      parameters: {
        type: 'object',
        properties: {
          query: { type: 'string', description: 'Search query' }
        },
        required: ['query']
      }
    }
  }]
});

console.log(response.choices[0].message.content);
// Response includes sources and citations

Порада Pro: Результати веб‑пошуку містять цитати. Shannon автоматично цитує джерела.

Формат Anthropic

Shannon також підтримує формат Anthropic Messages API.

https://api.shannon-ai.com/v1/messages

Python

import anthropic

client = anthropic.Anthropic(
    api_key="YOUR_API_KEY",
    base_url="https://api.shannon-ai.com/messages"
)

response = client.messages.create(
    model="shannon-1.6-lite",
    max_tokens=1024,
    messages=[
        {"role": "user", "content": "Hello, Shannon!"}
    ],
    # Tool use (Anthropic format)
    tools=[{
        "name": "web_search",
        "description": "Search the web",
        "input_schema": {
            "type": "object",
            "properties": {
                "query": {"type": "string"}
            },
            "required": ["query"]
        }
    }]
)

print(response.content[0].text)

JavaScript

import Anthropic from '@anthropic-ai/sdk';

const client = new Anthropic({
  apiKey: 'YOUR_API_KEY',
  baseURL: 'https://api.shannon-ai.com/messages'
});

const response = await client.messages.create({
  model: 'shannon-1.6-lite',
  max_tokens: 1024,
  messages: [
    { role: 'user', content: 'Hello, Shannon!' }
  ],
  // Tool use (Anthropic format)
  tools: [{
    name: 'web_search',
    description: 'Search the web',
    input_schema: {
      type: 'object',
      properties: {
        query: { type: 'string' }
      },
      required: ['query']
    }
  }]
});

console.log(response.content[0].text);

Обов’язковий header: Формат Anthropic вимагає anthropic-version: 2023-06-01.

SDK

Сумісний

Використовуйте будь‑який OpenAI або Anthropic SDK — просто змініть base URL.

OpenAI‑сумісні SDKs

SDK Python

Офіційний OpenAI Python SDK - працює з Shannon

pip install openai

Переглянути документацію ->

SDK JavaScript / TypeScript

Офіційний OpenAI Node.js SDK - працює з Shannon

npm install openai

Переглянути документацію ->

SDK Go

Community Go клієнт для OpenAI‑сумісних APIs

go get github.com/sashabaranov/go-openai

Переглянути документацію ->

SDK Ruby

Community Ruby клієнт для OpenAI‑сумісних APIs

gem install ruby-openai

Переглянути документацію ->

SDK PHP

Community PHP клієнт для OpenAI‑сумісних APIs

composer require openai-php/client

Переглянути документацію ->

SDK Rust

Async Rust клієнт для OpenAI‑сумісних APIs

cargo add async-openai

Переглянути документацію ->

Anthropic‑сумісні SDKs

SDK Python (Anthropic)

Офіційний Anthropic Python SDK - працює з Shannon

pip install anthropic

Переглянути документацію ->

SDK TypeScript (Anthropic)

Офіційний Anthropic TypeScript SDK - працює з Shannon

npm install @anthropic-ai/sdk

Переглянути документацію ->

Обробка помилок

Shannon використовує стандартні HTTP статус‑коди та повертає детальні повідомлення про помилки.

400 Некоректний запит Некоректний формат запиту або параметри

401 Неавторизовано Невірний або відсутній API ключ

402 Квота вичерпана Перевищено квоту токенів або пошуку

429 Rate Limit Забагато запитів, сповільніться

500 Помилка сервера Внутрішня помилка, спробуйте пізніше

Формат відповіді з помилкою

Відповідь з помилкою

{
  "error": {
    "message": "Invalid API key provided",
    "type": "authentication_error",
    "code": "invalid_api_key"
  }
}

Журнал змін

LOG

Останні оновлення та покращення Shannon API.

v2.1.0

2025-01-03

Нове Додано модель shannon-coder-1 для інтеграції з Claude Code CLI
Нове Система квот на виклики для моделі Coder
Покращено Покращена надійність виклику функцій

v2.0.0

2024-12-15

Нове Додано сумісність з Anthropic Messages API
Нове Багатоходове виконання інструментів (до 10 ітерацій)
Нове Підтримка формату відповіді JSON Schema
Покращено Покращений веб‑пошук з кращими цитатами

v1.5.0

2024-11-20

Нове Додано модель shannon-deep-dapo для складних міркувань
Нове Вбудована функція web_search
Покращено Зменшена затримка стрімінг відповідей

v1.0.0

2024-10-01

Нове Початковий реліз API
Нове OpenAI‑сумісний endpoint chat completions
Нове Підтримка виклику функцій
Нове Стрімінг через Server‑Sent Events

Ваш API‑ключ

Доступ

Використовуйте Bearer токени для OpenAI або X-API-Key + anthropic-version.

YOUR_API_KEY

Отримати API‑ключ

Зберігайте API ключ у таємниці. Регенерація створює новий ключ і скасовує старий.

Ваше використання

Переглядайте споживання токенів і пошуку на цій сторінці, коли ви увійшли.

-- API виклики

-- Використані токени

Shannon API

Огляд

Можливості

Drop‑in заміна

Виклик функцій

Вбудований веб‑пошук

Структуровані виходи

Багатоходові інструменти

Стрімінг

Швидкий старт

Встановіть base URL

Додайте ваш API ключ

Надішліть перше повідомлення

Формат відповіді

Playground

Chat, Responses, Messages

Stream live output

Reuse your key

Аутентифікація

Формат OpenAI (рекомендовано)

Формат Anthropic

Моделі

Виклик функцій

Опції вибору інструментів

Відповідь Function Call

Структуровані відповіді

Опції формату відповіді

Стримінг

Вбудований веб‑пошук

Формат Anthropic

SDK

OpenAI‑сумісні SDKs

Anthropic‑сумісні SDKs

Обробка помилок

Формат відповіді з помилкою

Журнал змін

Ваш API‑ключ

Ваше використання

Shannon Coder (shannon-coder-1)

Готові будувати?

Shannon AI API Documentation

Огляд

Можливості

Drop‑in заміна

Виклик функцій

Вбудований веб‑пошук

Структуровані виходи

Багатоходові інструменти

Стрімінг

Швидкий старт

Встановіть base URL

Додайте ваш API ключ

Надішліть перше повідомлення

Формат відповіді

Playground

Chat, Responses, Messages

Stream live output

Reuse your key

Аутентифікація

Формат OpenAI (рекомендовано)

Формат Anthropic

Моделі

Виклик функцій

Опції вибору інструментів

Відповідь Function Call

Структуровані відповіді

Опції формату відповіді

Стримінг

Вбудований веб‑пошук

Формат Anthropic

SDK

OpenAI‑сумісні SDKs

Anthropic‑сумісні SDKs

Обробка помилок

Формат відповіді з помилкою

Журнал змін

Ваш API‑ключ

Ваше використання

Shannon Coder (shannon-coder-1)

Готові будувати?