Документација за Shannon AI API

Преглед

Јавна документација

Сè што ти треба за да пуштиш со OpenAI и Anthropic компатибилниот API на Shannon.

Основен 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.

Заглавија Автентикација

Authorization: Bearer <api-key>

Или X-API-Key со anthropic-version за Claude стил повици.

Пристап Статус

Јавна документација - потребен е клуч за повик

Стриминг, повикување функции, структурирани излези, веб пребарување.

Контролна листа за лансирање

+

Насочи го SDK-от кон Shannon

Постави baseURL на OpenAI или Anthropic крајните точки погоре.

Поставување
+

Додај го твојот API клуч

Користи Bearer токени за OpenAI повици или X-API-Key + anthropic-version.

Безбедност
+

Овозможи алатки и структурирани излези

Поддржува OpenAI алатки/функции, JSON шема и вграден web_search.

Способности
+

Следи користење

Види потрошувачка на токени и пребарување на оваа страница кога си најавен.

Аналитика

Способности

OpenAI + Anthropic

Замена од типот drop-in за OpenAI и Anthropic API со нативна поддршка за алатки, структурирани излези и вградено веб пребарување.

Drop-in замена

Компатибилно

Работи со OpenAI и Anthropic SDK-ови. Само промени го основниот URL.

Повик на функции

Алатки

Дефинирај алатки, дозволи Shannon да ги повика. Поддржува auto, forced и none режими.

Вградено веб пребарување

Пребарување

Веб пребарување во реално време со цитати. Автоматски достапно.

Структурирани излези

JSON

JSON режим и наметнување JSON шема за сигурно извлекување податоци.

Алатки со повеќе чекори

Агентски

Автоматски циклуси за извршување функции. До 10 итерации по барање.

Стриминг

Брзо

Server-sent events за стриминг токени во реално време.

Брз почеток

5 минути

Започни во три чекори. Shannon ги огледува OpenAI и Anthropic клиентите.

Постави основен 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
  }
}

API 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.

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

Најдобро за Разговор, Прашања и одговори, Генерирање содржина

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": "..."}} Присили конкретен повик на функција

Одговор на повик на функција

Кога моделот повикува функција

{
  "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. Секој дел содржи 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);

Задолжително заглавие: Anthropic формат бара anthropic-version: 2023-06-01.

SDK

Компатибилно

Користи било кој OpenAI или Anthropic SDK – само смени го основниот URL.

OpenAI-компатибилни SDK-ови

SDK Python

Официјален OpenAI Python SDK – работи со Shannon

pip install openai

Погледни документи ->

SDK JavaScript / TypeScript

Официјален OpenAI Node.js SDK – работи со Shannon

npm install openai

Погледни документи ->

SDK Go

Заеднички Go клиент за OpenAI-компатибилни API

go get github.com/sashabaranov/go-openai

Погледни документи ->

SDK Ruby

Заеднички Ruby клиент за OpenAI-компатибилни API

gem install ruby-openai

Погледни документи ->

SDK PHP

Заеднички PHP клиент за OpenAI-компатибилни API

composer require openai-php/client

Погледни документи ->

SDK Rust

Асинхрон Rust клиент за OpenAI-компатибилни API

cargo add async-openai

Погледни документи ->

Anthropic-компатибилни SDK-ови

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 Ограничување на стапка Премногу барања, успорете

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 замена

Повик на функции

Вградено веб пребарување

Структурирани излези

Алатки со повеќе чекори

Стриминг

Брз почеток

Постави основен URL

Додај го твојот API клуч

Испрати ја првата порака

Формат на одговор

API Playground

Chat, Responses, Messages

Stream live output

Reuse your key

Автентикација

OpenAI формат (препорачано)

Anthropic формат

Модели

Повик на функции

Опции за избор на алатка

Одговор на повик на функција

Структурирани излези

Опции за формат на одговор

Стриминг

Вградено веб пребарување

Anthropic формат

SDK

OpenAI-компатибилни SDK-ови

Anthropic-компатибилни SDK-ови

Ракување со грешки

Формат на одговор за грешка

Дневник на промени

Твој API клуч

Твоја употреба

Shannon Coder (shannon-coder-1)

Подготвен да градиш?

Shannon AI API Documentation

Преглед

Способности

Drop-in замена

Повик на функции

Вградено веб пребарување

Структурирани излези

Алатки со повеќе чекори

Стриминг

Брз почеток

Постави основен URL

Додај го твојот API клуч

Испрати ја првата порака

Формат на одговор

API Playground

Chat, Responses, Messages

Stream live output

Reuse your key

Автентикација

OpenAI формат (препорачано)

Anthropic формат

Модели

Повик на функции

Опции за избор на алатка

Одговор на повик на функција

Структурирани излези

Опции за формат на одговор

Стриминг

Вградено веб пребарување

Anthropic формат

SDK

OpenAI-компатибилни SDK-ови

Anthropic-компатибилни SDK-ови

Ракување со грешки

Формат на одговор за грешка

Дневник на промени

Твој API клуч

Твоја употреба

Shannon Coder (shannon-coder-1)

Подготвен да градиш?