Tài liệu API Shannon AI

Tổng quan

Tài liệu công khai

Tất cả những gì bạn cần để triển khai với API tương thích OpenAI và Anthropic của Shannon.

URL cơ sở Tương thích OpenAI

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

Sử dụng Chat Completions API với function calling và streaming.

URL cơ sở Tương thích Anthropic

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

Định dạng Claude Messages với tools và header anthropic-version.

Tiêu đề Xác thực

Ủy quyền: Bearer <khoa-cua-ban>

Hoặc dùng X-API-Key + anthropic-version cho các lệnh gọi kiểu Claude.

Access Status

Public docs - Key required to call

Streaming, function calling, đầu ra có cấu trúc và tìm kiếm web.

Checklist triển khai

+

Trỏ SDK của bạn tới Shannon

Đặt baseURL tới endpoint OpenAI hoặc Anthropic ở trên.

Setup
+

Thêm API key của bạn

Dùng Bearer cho OpenAI hoặc X-API-Key + anthropic-version.

Security
+

Bật tools và đầu ra có cấu trúc

Hỗ trợ OpenAI tools/functions, JSON schema và web_search tích hợp.

Tính năng
+

Theo dõi sử dụng

Xem mức dùng token và tìm kiếm trên trang này sau khi đăng nhập.

Analytics

Tính năng

OpenAI + Anthropic

Thay thế trực tiếp OpenAI và Anthropic API với hỗ trợ native cho tools, đầu ra có cấu trúc và tìm kiếm web tích hợp.

Thay thế drop‑in

Tương thích

Hoạt động với SDK OpenAI và Anthropic. Chỉ cần đổi base URL.

Gọi hàm

Công cụ

Định nghĩa công cụ, để Shannon gọi chúng. Hỗ trợ các chế độ auto, forced và none.

Tìm kiếm web tích hợp

Tìm kiếm

Tìm kiếm web thời gian thực kèm trích dẫn nguồn. Tự động khả dụng.

Đầu ra có cấu trúc

JSON

Chế độ JSON và ép JSON Schema để trích xuất dữ liệu tin cậy.

Công cụ đa lượt

Tác nhân

Vòng lặp thực thi hàm tự động. Tối đa 10 lần lặp mỗi yêu cầu.

Truyền phát

Nhanh

SSE để stream token thời gian thực.

Bắt đầu nhanh

5 phút

Bắt đầu trong ba bước. Shannon mô phỏng client OpenAI và Anthropic.

Đặt base URL

Dùng endpoint tương thích OpenAI.

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

Thêm API key

Dùng Bearer auth trong header Authorization.

Gửi tin nhắn đầu tiên

Chọn ngôn ngữ và thay key của bạn.

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

Định dạng phản hồi

Phản hồi thành công

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

Sân chơi API

Mới

Thử API Shannon trực tiếp trong trình duyệt. Tạo yêu cầu, chạy và xem phản hồi theo thời gian thực.

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.

/vi/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.

Thử Playground V2 Nhận khóa API

Xác thực

Mọi request API đều cần xác thực bằng Shannon API key của bạn.

OpenAI Format (Recommended)

HTTP

Authorization: Bearer YOUR_API_KEY

Định dạng Anthropic

HTTP

X-API-Key: YOUR_API_KEY
anthropic-version: 2023-06-01

Mô hình

Shannon cung cấp nhiều mô hình tối ưu cho các use case khác nhau.

shannon-1.6-lite Shannon 1.6 Lite

Fast, efficient responses for everyday tasks

Ngữ cảnh 128K

Phù hợp nhất cho Chat, Q&A, Content Generation

shannon-1.6-pro Shannon 1.6 Pro

Advanced reasoning for complex problems

Ngữ cảnh 128K

Phù hợp nhất cho Analysis, Research, Complex Tasks

shannon-2-lite Shannon 2 Lite

Ngữ cảnh 128K

Phù hợp nhất cho

shannon-2-pro Shannon 2 Pro

Ngữ cảnh 128K

Phù hợp nhất cho

shannon-coder-1 Shannon Coder

Optimized for Claude Code CLI with call-based quota

Ngữ cảnh 128K

Phù hợp nhất cho Code Generation, Tool Use, CLI Integration

Call-based quota

Gọi hàm

Define tools that Shannon can call to perform actions or retrieve information.

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

Tùy chọn chọn công cụ

"auto" Model decides whether to call a function (default)

"none" Disable function calling for this request

{"type": "function", "function": {"name": "..."}} Force a specific function call

Phản hồi gọi hàm

When model calls a 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"
    }
  ]
}

Đầu ra có cấu trúc

Force Shannon to respond with valid JSON that matches your 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" }

Tùy chọn định dạng phản hồi

{"type": "json_object"} Force valid JSON output (no specific schema)

{"type": "json_schema", "json_schema": {...}} Force output matching your exact schema

Truyền phát

Enable real-time token streaming with Server-Sent Events for responsive UIs.

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

Mẹo: Streaming responses arrive as Server-Sent Events. Each chunk contains a delta with partial content.

Tìm kiếm web tích hợp

Shannon includes a built-in web_search function that's automatically available.

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

Mẹo chuyên gia: Kết quả tìm kiếm web có kèm trích dẫn. Shannon sẽ tự động trích nguồn.

Định dạng Anthropic

Shannon cũng hỗ trợ định dạng 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);

Tiêu đề bắt buộc: Anthropic format requires anthropic-version: 2023-06-01.

CLI Coding Agents

NEW

Use Shannon as the AI backend for popular CLI coding agents. Read files, edit code, run tests — all powered by Shannon's API.

CLI Claude Code

Anthropic's official CLI coding agent. Point it at Shannon to use as your AI backend for reading, editing, and running code directly in your terminal.

ANTHROPIC_BASE_URL=https://api.shannon-ai.com ANTHROPIC_API_KEY=sk-YOUR_KEY claude --bare

View Docs ->

CLI Codex CLI

OpenAI's open-source coding agent. Uses the Responses API for multi-turn tool use, file editing, and shell commands — all routed through Shannon.

OPENAI_BASE_URL=https://api.shannon-ai.com/v1 OPENAI_API_KEY=sk-YOUR_KEY codex

View Docs ->

Claude Code

Anthropic's official CLI coding agent. Set two environment variables and launch with --bare to skip Anthropic account login.

Bash

# Install Claude Code (requires Node.js 18+)
npm install -g @anthropic-ai/claude-code

# Connect to Shannon AI as backend
export ANTHROPIC_BASE_URL=https://api.shannon-ai.com
export ANTHROPIC_API_KEY=sk-YOUR_API_KEY

# Launch Claude Code in bare mode (no Anthropic account needed)
claude --bare

# Or run a one-shot command
claude --bare -p "Explain this codebase"

# Claude Code will use Shannon's Anthropic-compatible API
# for all AI operations: reading files, editing code,
# running tests, and multi-turn tool use.

Shell Config

# Alternative: set env vars permanently in your shell profile
# ~/.bashrc or ~/.zshrc

export ANTHROPIC_BASE_URL=https://api.shannon-ai.com
export ANTHROPIC_API_KEY=sk-YOUR_API_KEY

# Then just run:
claude --bare

# Supported features through Shannon:
# - Multi-turn conversations with full context
# - File reading and editing (tool use)
# - Shell command execution
# - Streaming responses
# - All Claude Code slash commands (/compact, /clear, etc.)

Codex CLI

OpenAI's open-source coding agent. Uses the Responses API for multi-turn tool use, file editing, and shell commands.

Bash

# Install Codex CLI
npm install -g @openai/codex

# Connect to Shannon AI as backend
export OPENAI_BASE_URL=https://api.shannon-ai.com/v1
export OPENAI_API_KEY=sk-YOUR_API_KEY

# Launch Codex
codex

# Or run a one-shot command
codex "fix the bug in main.py"

# Codex uses the Responses API (POST /v1/responses)
# Shannon handles tool calls including:
# - Reading and writing files
# - Running shell commands
# - Multi-turn function calling

Shell Config

# Alternative: set env vars permanently
# ~/.bashrc or ~/.zshrc

export OPENAI_BASE_URL=https://api.shannon-ai.com/v1
export OPENAI_API_KEY=sk-YOUR_API_KEY

# Then just run:
codex

# Supported features through Shannon:
# - Responses API with full tool use
# - Function calling (file read/write, shell exec)
# - Streaming with real-time output
# - Multi-turn conversations
# - All Codex approval modes (suggest, auto-edit, full-auto)

How It Works: Both tools send standard API requests (Anthropic Messages or OpenAI Responses) to Shannon. Shannon routes them through Gemini with full tool-use support. No Anthropic or OpenAI account needed — just your Shannon API key.

SDK

Tương thích

Use any OpenAI or Anthropic SDK - just change the base URL.

OpenAI-Compatible SDKs

SDK Python

Official OpenAI Python SDK - works with Shannon

pip install openai

View Docs ->

SDK JavaScript / TypeScript

Official OpenAI Node.js SDK - works with Shannon

npm install openai

View Docs ->

SDK Go

Community Go client for OpenAI-compatible APIs

go get github.com/sashabaranov/go-openai

View Docs ->

SDK Ruby

Community Ruby client for OpenAI-compatible APIs

gem install ruby-openai

View Docs ->

SDK PHP

Community PHP client for OpenAI-compatible APIs

composer require openai-php/client

View Docs ->

SDK Rust

Async Rust client for OpenAI-compatible APIs

cargo add async-openai

View Docs ->

Anthropic-Compatible SDKs

SDK Python (Anthropic)

Official Anthropic Python SDK - works with Shannon

pip install anthropic

View Docs ->

SDK TypeScript (Anthropic)

Official Anthropic TypeScript SDK - works with Shannon

npm install @anthropic-ai/sdk

View Docs ->

Xử lý lỗi

Shannon dùng mã trạng thái HTTP tiêu chuẩn và trả về lỗi chi tiết.

400 Yêu cầu không hợp lệ Định dạng yêu cầu hoặc tham số không hợp lệ

401 Không được phép API key không hợp lệ hoặc thiếu

402 Vượt quá quota Vượt quá quota token hoặc tìm kiếm

429 Giới hạn tốc độ Quá nhiều yêu cầu, hãy chậm lại

500 Lỗi máy chủ Lỗi nội bộ, thử lại sau

Định dạng phản hồi lỗi

Phản hồi lỗi

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

Nhật ký thay đổi

LOG

Recent updates and improvements to the Shannon API.

v2.2.0

2026-03-28

Mới Claude Code support — use Shannon as your Anthropic backend for the official CLI coding agent
Mới Codex CLI support — full Responses API with multi-turn tool use for OpenAI's coding agent
Improved Anthropic streaming format fixes — proper content_block lifecycle, tool_use deltas, toolu_ prefixes
Improved Schema sanitization for Gemini — strips $schema, additionalProperties, $ref and other unsupported fields from tool schemas

v2.1.0

2025-01-03

Mới Added shannon-coder-1 model for Claude Code CLI integration
Mới Call-based quota system for Coder model
Improved Improved function calling reliability

v2.0.0

2024-12-15

Mới Added Anthropic Messages API compatibility
Mới Multi-turn tool execution (up to 10 iterations)
Mới JSON Schema response format support
Improved Enhanced web search with better citations

v1.5.0

2024-11-20

Mới Added shannon-deep-dapo model for complex reasoning
Mới Built-in web_search function
Improved Reduced latency for streaming responses

v1.0.0

2024-10-01

Mới Initial API release
Mới OpenAI-compatible chat completions endpoint
Mới Function calling support
Mới Streaming via Server-Sent Events

API key của bạn

Access

Dùng Bearer cho OpenAI hoặc X-API-Key + anthropic-version.

YOUR_API_KEY

Nhận khóa API

Giữ API key bí mật. Việc tạo lại tạo key mới và vô hiệu hóa key cũ.

Mức sử dụng

Xem mức dùng token và tìm kiếm trên trang này sau khi đăng nhập.

-- Lượt gọi API

-- Token đã dùng

Shannon AI API Documentation

Tổng quan

Tính năng

Thay thế drop‑in

Gọi hàm

Tìm kiếm web tích hợp

Đầu ra có cấu trúc

Công cụ đa lượt

Truyền phát

Bắt đầu nhanh

Đặt base URL

Thêm API key

Gửi tin nhắn đầu tiên

Định dạng phản hồi

Sân chơi API

Chat, Responses, Messages

Stream live output

Reuse your key

Xác thực

OpenAI Format (Recommended)

Định dạng Anthropic

Mô hình

Gọi hàm

Tùy chọn chọn công cụ

Phản hồi gọi hàm

Đầu ra có cấu trúc

Tùy chọn định dạng phản hồi

Truyền phát

Tìm kiếm web tích hợp

Định dạng Anthropic

CLI Coding Agents

Claude Code

Codex CLI

SDK

OpenAI-Compatible SDKs

Anthropic-Compatible SDKs

Xử lý lỗi

Định dạng phản hồi lỗi

Nhật ký thay đổi

API key của bạn

Mức sử dụng

Shannon Coder (shannon-coder-1)

Sẵn sàng xây dựng?