Shannon AI API Құжаттамасы

Шолу

Ашық құжаттама

Shannon-ның OpenAI және Anthropic үйлесімді API-імен іске қосу үшін қажеттінің бәрі.

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>

Немесе Claude стиліндегі шақырулар үшін X-API-Key және anthropic-version.

Қолжетімділік Күй

Ашық құжаттама - шақыру үшін кілт қажет

Стриминг, функция шақыру, құрылымдалған нәтижелер, веб іздеу.

Іске қосу тізімі

+

SDK-ны Shannon-ға бағыттаңыз

baseURL-ді жоғарыдағы OpenAI немесе Anthropic endpoint-теріне орнатыңыз.

Баптау
+

API кілтіңізді қосыңыз

OpenAI шақырулары үшін Bearer токендерін немесе X-API-Key + anthropic-version қолданыңыз.

Қауіпсіздік
+

Құралдар мен құрылымдалған нәтижелерді қосыңыз

OpenAI tools/functions, JSON schema және кіріктірілген web_search қолдайды.

Мүмкіндіктер
+

Қолданысты бақылау

Тіркелгенде осы беттен токен және іздеу шығынын көріңіз.

Аналитика

Мүмкіндіктер

OpenAI + Anthropic

OpenAI және Anthropic API-леріне drop-in алмастыру: құралдар, құрылымдалған нәтижелер және кіріктірілген веб іздеу қолдауы бар.

Drop-in алмастыру

Үйлесімді

OpenAI және Anthropic SDK-ларымен жұмыс істейді. 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 кілтін қосыңыз

Authorization хедерінде Bearer аутентификациясын пайдаланыңыз.

Алғашқы хабарлама жіберіңіз

Тілді таңдаңыз және кілтіңізді ауыстырыңыз.

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.

/kk/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": {...}} Дәл сұлбаңызға сай шығуды мәжбүрлеу

Стриминг

Жауапты UI үшін Server-Sent Events арқылы нақты уақыт токен стримингін қосыңыз.

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 пайдаланыңыз — тек base 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

OpenAI-үйлесімді API үшін қауымдастық Go клиенті

go get github.com/sashabaranov/go-openai

Құжаттарды көру ->

SDK Ruby

OpenAI-үйлесімді API үшін қауымдастық Ruby клиенті

gem install ruby-openai

Құжаттарды көру ->

SDK PHP

OpenAI-үйлесімді API үшін қауымдастық PHP клиенті

composer require openai-php/client

Құжаттарды көру ->

SDK Rust

OpenAI-үйлесімді API үшін Async Rust клиенті

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

Жаңа Claude Code CLI интеграциясы үшін shannon-coder-1 моделі қосылды
Жаңа 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 кілтіңіз

Қолжетімділік

OpenAI шақырулары үшін Bearer токендерін немесе X-API-Key + anthropic-version қолданыңыз.

YOUR_API_KEY

API кілтін алу

API кілтіңізді құпия сақтаңыз. Қайта жасау жаңа кілт жасап, ескісін күшін жояды.

Сіздің пайдалануыңыз

Тіркелгенде осы беттен токен және іздеу шығынын көріңіз.

-- API шақырулары

-- Қолданылған токендер

Shannon API

Шолу

Мүмкіндіктер

Drop-in алмастыру

Функция шақыру

Кіріктірілген веб іздеу

Құрылымдалған нәтижелер

Көп қадамды құралдар

Стриминг

Жылдам бастау

Base 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 алмастыру

Функция шақыру

Кіріктірілген веб іздеу

Құрылымдалған нәтижелер

Көп қадамды құралдар

Стриминг

Жылдам бастау

Base 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)

Құруға дайынсыз ба?