Ҳуҷҷатгузории Shannon AI API

Шарҳ

Ҳуҷҷатҳои умумӣ

Ҳама чиз барои оғоз бо API-и мувофиқи OpenAI ва Anthropic-и Shannon.

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 ва header-и anthropic-version.

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

Authorization: Bearer <api-key>

Ё X-API-Key бо anthropic-version барои даъватҳои Claude style.

Дастрасӣ Ҳолат

Ҳуҷҷатҳои умумӣ - барои call кардан калид лозим

Streaming, function calling, structured outputs, web search.

Рӯйхати оғоз

+

SDK-ро ба Shannon равона кунед

baseURL-ро ба endpoint-и OpenAI ё Anthropic боло муқаррар кунед.

Танзим
+

Калиди 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

Drop-in replacement барои OpenAI ва Anthropic API; tools, structured outputs ва built-in web search дастгирӣ мешавад.

Drop-in replacement

Мувофиқ

Бо OpenAI ва Anthropic SDK кор мекунад. Танҳо base URL-ро иваз кунед.

Даъвати функсия

Tools

Tools-ро муайян кунед, ба Shannon иҷозат диҳед, ки онҳоро даъват кунад. auto, forced, none режимҳо дастгирӣ мешаванд.

Ҷустуҷӯи веб

Ҷустуҷӯ

Веб ҷустуҷӯи вақти воқеӣ бо cited sources. Автоматӣ дастрас аст.

Баромадҳои сохторӣ

JSON

JSON mode ва JSON Schema enforce барои extraction-и боэътимод.

Multi-turn Tools

Agentic

Function execution loops-и автоматӣ. То 10 iteration барои ҳар request.

Стриминг

Fast

Server-sent events барои real-time token streaming.

Оғози зуд

5 дақиқа

Дар се қадам оғоз кунед. Shannon OpenAI ва Anthropic clients-ро инъикос мекунад.

Base URL-ро муқаррар кунед

Endpoint-и OpenAI-compatible-ро истифода баред.

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.

/tg/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 аутентификатсия мешаванд.

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

Разумгардонии пешрафта барои масъалаҳои мураккаб

Контекст 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

Барои мутахассисони амният сохта шудааст Эҷоди код, Истифодаи tools, CLI интегратсия

Call-based quota

Даъвати функсия

Tools-ро муайян кунед, ки 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" Модел худаш қарор медиҳад, function-ро даъват кунад ё не (default)

"none" Function calling-ро барои ин request хомӯш кунед

{"type": "function", "function": {"name": "..."}} Function-ро маҷбурӣ даъват кунед

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-ро маҷбур кунед, JSON-и дуруст мувофиқи schema-и шумо баргардонад.

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": {...}} Output-и мувофиқи schema-и дақиқи шумо

Стриминг

Барои 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 responses ҳамчун Server-Sent Events меоянд. Ҳар chunk delta-и мундариҷаи қисмӣ дорад.

Ҷустуҷӯи веб

Shannon дорои function-и 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

Maslihat: Натиҷаҳои web search бо 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);

Required: Anthropic format ба anthropic-version: 2023-06-01 ниёз дорад.

SDKҳо

Мувофиқ

Ҳар гуна 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

Community Go client барои OpenAI-compatible API

go get github.com/sashabaranov/go-openai

Ҳуҷҷатҳоро бинед ->

SDK Ruby

Community Ruby client барои OpenAI-compatible API

gem install ruby-openai

Ҳуҷҷатҳоро бинед ->

SDK PHP

Community PHP client барои OpenAI-compatible API

composer require openai-php/client

Ҳуҷҷатҳоро бинед ->

SDK Rust

Async Rust client барои OpenAI-compatible API

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 code-ро истифода мебарад ва хатогиҳои муфассал бармегардонад.

400 Bad Request Формати дархост ё параметрҳо нодурустанд

401 Unauthorized Калиди API нодуруст ё нест

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

Нав Модели shannon-coder-1 барои интегратсияи Claude Code CLI илова шуд
Нав Системаи quota-и call-based барои модели Coder
Беҳбуд Эътимоднокии function calling беҳтар шуд

v2.0.0

2024-12-15

Нав Мутобиқати Anthropic Messages API илова шуд
Нав Иҷрои multi-turn tool (то 10 iterations)
Нав Дастгирии JSON Schema response format
Беҳбуд Web search бо citations беҳтар шуд

v1.5.0

2024-11-20

Нав Модели shannon-deep-dapo барои reasoning-и мураккаб илова шуд
Нав Function-и built-in web_search
Беҳбуд Кам шудани latency-и streaming responses

v1.0.0

2024-10-01

Нав Нашри аввали API
Нав OpenAI-compatible chat completions endpoint
Нав Дастгирии function calling
Нав Streaming тавассути Server-Sent Events

Калиди API-и шумо

Дастрасӣ

Барои OpenAI calls Bearer token ё X-API-Key + anthropic-version истифода баред.

YOUR_API_KEY

Калиди API-и худро гиред

Калиди API-и худро махфӣ нигоҳ доред. Regenerate калиди нав эҷод карда, кӯҳнаро беэътибор мекунад.

Истифодаи шумо

Ҳангоми воридшавӣ дар ин саҳифа истифодаи 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)

Омодаи сохтани он ҳастед?