Shannon AI API Документациясы

Обзор

Ачык документация

Shannon'дун OpenAI жана Anthropic менен шайкеш API'и менен баштоо үчүн керектүү нерселердин баары.

URL OpenAI-менен шайкеш

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

Chat Completions API'ни function calling жана streaming менен колдонуңуз.

URL Anthropic-менен шайкеш

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

Claude Messages форматы tools жана anthropic-version header менен.

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

Authorization: Bearer <api-key>

Же Claude style чакыруулар үчүн X-API-Key жана anthropic-version.

Жеткиликтүүлүк Абал

Ачык документация - чалууга key керек

Streaming, function calling, structured outputs, web search.

Ишке киргизүү тизмеси

+

SDK'ни Shannon'го багыттаңыз

baseURL'ди жогорудагы OpenAI же Anthropic endpoint'терге коюңуз.

Орнотуу
+

API ачкычыңызды кошуңуз

OpenAI calls үчүн Bearer token же X-API-Key + anthropic-version колдонуңуз.

Коопсуздук
+

Tools жана structured outputs күйгүзүңүз

OpenAI tools/functions, JSON schema жана built-in web_search колдойт.

Мүмкүнчүлүктөр
+

Колдонууңузду байкап туруңуз

Киргенде бул беттен token жана search колдонулушун көрүңүз.

Аналитика

Мүмкүнчүлүктөр

OpenAI + Anthropic

OpenAI жана Anthropic API'лер үчүн drop-in replacement; tools, structured outputs жана built-in web search колдоосу бар.

Drop-in Replacement

Compatible

OpenAI жана Anthropic SDK'лер менен иштейт. base URL'ди гана өзгөртүңүз.

Функция чакыруу

Tools

Tools'ту аныктаңыз, Shannon аларды чакырсын. auto, forced, none режимдери колдоого алынат.

Веб издөө

Издөө

Булак шилтемелери менен реалдуу убакыт веб издөө. Автоматтык жеткиликтүү.

Түзүмдүү чыгыштар

JSON

Ишенимдүү маалымат алуу үчүн JSON mode жана JSON Schema enforcement.

Multi-turn Tools

Agentic

Автоматтык function execution loops. Ар бир request үчүн 10 iteration чейин.

Стриминг

Fast

Server-sent events аркылуу real-time token streaming.

Тез баштоо

5 мүнөт

Үч кадамда баштаңыз. Shannon OpenAI жана Anthropic клиенттерин чагылдырат.

Base URL коюңуз

OpenAI-compatible endpoint колдонуңуз.

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

API ачкычын кошуңуз

Authorization header'де Bearer auth колдонуңуз.

Алгачкы билдирүү жөнөтүңүз

Тилди тандап, ачкычыңызды алмаштырыңыз.

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
  }'

Response format

Success Response

{
  "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.

/ky/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 request'тер Shannon API key аркылуу аутентификацияны талап кылат.

OpenAI Format (сунушталат)

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

Күрдөөлдүү маселелер үчүн терең reasoning

Контекст 128K

Коопсуздук адистери үчүн курулган Анализ, Изилдөө, Татаал иштер

shannon-2-lite Shannon 2 Lite

Контекст 128K

Коопсуздук адистери үчүн курулган

shannon-2-pro Shannon 2 Pro

Контекст 128K

Коопсуздук адистери үчүн курулган

shannon-coder-1 Shannon Coder

Claude Code CLI үчүн call-based quota менен оптималдаштырылган

Контекст 128K

Коопсуздук адистери үчүн курулган Код генерациясы, Tool колдонуу, CLI интеграция

Call-based quota

Функция чакыруу

Shannon чакыра турган tools'ту аныктаңыз — аракеттерди аткаруу же маалымат алуу үчүн.

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" Модель function чакыруу-качырбоону өзү чечет (default)

"none" Бул request үчүн function calling'ди өчүрүңүз

{"type": "function", "function": {"name": "..."}} Белгилүү function call'ду мажбурлаңыз

Response format

Модель function чакырганда

{
  "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'ду schemaңызга ылайык valid 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" }

Response format

{"type": "json_object"} Valid JSON output'ту мажбурлаңыз (атайын schema жок)

{"type": "json_schema", "json_schema": {...}} Schemaңызга дал келген output'ту мажбурлаңыз

Стриминг

Responsive UI үчүн Server-Sent Events менен real-time token streaming'ди күйгүзүңүз.

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);
}

Кеңеш: Streaming жооптор Server-Sent Events катары келет. Ар бир chunk'та жарым контенттүү delta болот.

Веб издөө

Shannon ичинде автоматтык жеткиликтүү web_search function бар.

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

Kenes: Web search натыйжаларында цитаталар бар. 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);

Required: Anthropic format үчүн anthropic-version: 2023-06-01 талап кылынат.

SDKлар

Compatible

Кайсы болбосун OpenAI же Anthropic SDK колдонуңуз — base URL'ди гана өзгөртүңүз.

OpenAI-Compatible SDKs

SDK Python

Official OpenAI Python SDK — Shannon менен иштейт

pip install openai

Документацияны көрүү ->

SDK JavaScript / TypeScript

Official OpenAI Node.js SDK — Shannon менен иштейт

npm install openai

Документацияны көрүү ->

SDK Go

OpenAI-compatible API үчүн community Go client

go get github.com/sashabaranov/go-openai

Документацияны көрүү ->

SDK Ruby

OpenAI-compatible API үчүн community Ruby client

gem install ruby-openai

Документацияны көрүү ->

SDK PHP

OpenAI-compatible API үчүн community PHP client

composer require openai-php/client

Документацияны көрүү ->

SDK Rust

OpenAI-compatible API үчүн Async Rust client

cargo add async-openai

Документацияны көрүү ->

Anthropic-Compatible SDKs

SDK Python (Anthropic)

Official Anthropic Python SDK — Shannon менен иштейт

pip install anthropic

Документацияны көрүү ->

SDK TypeScript (Anthropic)

Official Anthropic TypeScript SDK — Shannon менен иштейт

npm install @anthropic-ai/sdk

Документацияны көрүү ->

Ката иштетүү

Shannon стандарттуу HTTP status коддорун колдонуп, деталдуу ката билдирүүлөрүн кайтарат.

400 Bad Request Суроо форматы же параметрлер туура эмес

401 Unauthorized API key туура эмес же жок

402 Quota Exceeded Token же search quota ашып кетти

429 Rate Limited Өтө көп суроо, жайлаңыз

500 Server Error Ички ката, кийин кайра аракет кылыңыз

Error Response Format

Error Response

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

Өзгөртүүлөр журналы

LOG

Shannon API'нин акыркы жаңыртуулары жана жакшыртуулары.

v2.1.0

2025-01-03

Жаңы Claude Code CLI интеграциясы үчүн shannon-coder-1 модели кошулду
Жаңы Coder модели үчүн call-based quota системасы
Жакшыртылды Function calling ишенимдүүлүгү жакшырды

v2.0.0

2024-12-15

Жаңы Anthropic Messages API шайкештиги кошулду
Жаңы Multi-turn tool execution (10 iterations чейин)
Жаңы JSON Schema response format колдоосу
Жакшыртылды Citations менен web search жакшырды

v1.5.0

2024-11-20

Жаңы Күрдөөл reasoning үчүн shannon-deep-dapo модели кошулду
Жаңы Built-in web_search function
Жакшыртылды Streaming response'дун кечигүүсү азайды

v1.0.0

2024-10-01

Жаңы API'нин баштапкы чыгарылышы
Жаңы OpenAI-compatible chat completions endpoint
Жаңы Function calling колдоосу
Жаңы Server-Sent Events аркылуу streaming

API ачкычыңыз

Жеткиликтүүлүк

OpenAI calls үчүн Bearer token же X-API-Key + anthropic-version колдонуңуз.

YOUR_API_KEY

API ачкычын алуу

API ачкычыңызды купуя сактаңыз. Regenerate жаңы key түзүп, эскисин жараксыз кылат.

Сиздин колдонуу

Киргенде бул беттен token жана search колдонулушун көрүңүз.

-- API Calls

-- Tokens Used

Shannon API

Обзор

Мүмкүнчүлүктөр

Drop-in Replacement

Функция чакыруу

Веб издөө

Түзүмдүү чыгыштар

Multi-turn Tools

Стриминг

Тез баштоо

Base URL коюңуз

API ачкычын кошуңуз

Алгачкы билдирүү жөнөтүңүз

Response format

API Playground

Chat, Responses, Messages

Stream live output

Reuse your key

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

OpenAI Format (сунушталат)

Anthropic

Моделдер

Функция чакыруу

Функция чакыруу

Response format

Түзүмдүү чыгыштар

Response format

Стриминг

Веб издөө

Anthropic

SDKлар

OpenAI-Compatible SDKs

Anthropic-Compatible SDKs

Ката иштетүү

Error Response Format

Өзгөртүүлөр журналы

API ачкычыңыз

Сиздин колдонуу

Shannon Coder (shannon-coder-1)

Курууга даярсызбы?

Shannon AI API Documentation

Обзор

Мүмкүнчүлүктөр

Drop-in Replacement

Функция чакыруу

Веб издөө

Түзүмдүү чыгыштар

Multi-turn Tools

Стриминг

Тез баштоо

Base URL коюңуз

API ачкычын кошуңуз

Алгачкы билдирүү жөнөтүңүз

Response format

API Playground

Chat, Responses, Messages

Stream live output

Reuse your key

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

OpenAI Format (сунушталат)

Anthropic

Моделдер

Функция чакыруу

Функция чакыруу

Response format

Түзүмдүү чыгыштар

Response format

Стриминг

Веб издөө

Anthropic

SDKлар

OpenAI-Compatible SDKs

Anthropic-Compatible SDKs

Ката иштетүү

Error Response Format

Өзгөртүүлөр журналы

API ачкычыңыз

Сиздин колдонуу

Shannon Coder (shannon-coder-1)

Курууга даярсызбы?