Документация на 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 header.

Хедъри Удостоверяване

Авторизация: 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 header.

Изпратете първото си съобщение

Изберете език и поставете ключа си.

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

Ново

Тествайте Shannon API директно в браузъра. Създайте заявка, стартирайте и вижте отговора в реално време.

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.

/bg/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

Про съвет: Резултатите от уеб търсене съдържат цитати. 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‑съвместим chat completions endpoint
Ново Поддръжка на извикване на функции
Ново Стрийминг чрез 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)

Готови ли сте да изграждате?