Penggantian Drop-in
serasiBerfungsi dengan OpenAI dan SDK Anthropic. Hanya tukar URL asas.
Dokumentasi API
API Shannon
API AI serasi OpenAI & Anthropic dengan panggilan fungsi, carian web dan output berstruktur.
Shannon AI API Documentation
Gambaran keseluruhan
Dokumen awamSemua yang anda perlukan untuk dihantar dengan OpenAI Shannon dan API serasi Anthropic.
https://api.shannon-ai.com/v1/chat/completions Gunakan API Penyiapan Sembang dengan panggilan fungsi dan penstriman.
https://api.shannon-ai.com/v1/messages Format Claude Messages dengan alat dan pengepala versi antropik.
Keizinan: Pembawa <kunci-anda> Atau X-API-Key dengan versi antropik untuk panggilan gaya Claude.
Dokumen awam - Kunci diperlukan untuk membuat panggilan Penstriman, panggilan fungsi, output berstruktur, carian web.
Pelancaran senarai semak
- + PersediaanHalakan SDK anda ke ShannonTetapkan baseURL kepada titik akhir OpenAI atau Anthropic di atas.
- + KeselamatanLampirkan kunci API andaGunakan token Pembawa untuk panggilan OpenAI atau X-API-Key + versi antropik.
- + KeupayaanDayakan alatan & output berstrukturMenyokong alat/fungsi OpenAI, skema JSON dan carian web terbina dalam.
- + AnalitisJejaki penggunaanLihat token dan penggunaan carian pada halaman ini apabila log masuk ke akaun anda.
Keupayaan
OpenAI + AnthropicPenggantian drop-in untuk OpenAI dan API Anthropic dengan sokongan asli untuk alatan, output berstruktur dan carian web terbina dalam.
Panggilan Fungsi
AlatanTentukan alatan, biarkan Shannon memanggilnya. Menyokong mod auto, paksa dan tiada.
Carian Web Terbina dalam
CariCarian web masa nyata dengan petikan sumber. Tersedia secara automatik.
Output Berstruktur
JSONJSON mod dan JSON Penguatkuasaan skema untuk pengekstrakan data yang boleh dipercayai.
Alat berbilang pusingan
AgentikGelung perlaksanaan fungsi automatik. Sehingga 10 lelaran setiap permintaan.
Penstriman
CepatAcara yang dihantar pelayan untuk penstriman token masa nyata.
Mula Pantas
5 minitMulakan dalam tiga langkah. Shannon mencerminkan pelanggan OpenAI dan Anthropic.
1
Tetapkan URL asas anda
Gunakan titik akhir yang serasi dengan OpenAI.
https://api.shannon-ai.com/v1/chat/completions 2
Tambahkan kunci API anda
Gunakan pengesahan Pembawa dalam pengepala Kebenaran.
3
Hantar mesej pertama anda
Pilih bahasa dan tukar kunci anda.
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); Go
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
}'Format jawapan
Respons Kejayaan
{
"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
}
}Taman Permainan API
baruUji API Shannon secara langsung dalam penyemak imbas anda. Bina permintaan anda, jalankan dan lihat respons dalam masa nyata.
1
Chat, Responses, Messages
Switch across OpenAI Chat Completions, Responses, and Anthropic Messages without leaving the playground.
2
Stream live output
Run real requests, inspect raw JSON, and view stream events from the same operator console.
3
Reuse your key
Signed-in users can pull their Shannon API key straight into the dedicated playground workspace.
/ms/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.
Pengesahan
Semua permintaan API memerlukan pengesahan menggunakan kunci API Shannon anda.
Format OpenAI (Disyorkan)
HTTP
Authorization: Bearer YOUR_API_KEYFormat Antropik
HTTP
X-API-Key: YOUR_API_KEY
anthropic-version: 2023-06-01model
Shannon menawarkan berbilang model yang dioptimumkan untuk kes penggunaan yang berbeza.
shannon-1.6-lite Shannon 1.6 Lite Respons yang pantas dan cekap untuk tugasan harian
shannon-1.6-pro Shannon 1.6 Pro Penaakulan lanjutan untuk masalah yang kompleks
shannon-2-lite Shannon 2 Lite
shannon-2-pro Shannon 2 Pro
shannon-coder-1 Shannon Coder Dioptimumkan untuk Claude Code CLI dengan kuota berasaskan panggilan
Kuota berasaskan panggilan
Panggilan Fungsi
Tentukan alat yang boleh dipanggil oleh Shannon untuk melakukan tindakan atau mendapatkan maklumat.
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);
}Pilihan Pilihan Alat
Respons Panggilan Fungsi
Apabila model memanggil fungsi
{
"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"
}
]
}Output Berstruktur
Paksa Shannon untuk membalas dengan JSON yang sah yang sepadan dengan skema anda.
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" }Pilihan Format Respons
Penstriman
Dayakan penstriman token masa nyata dengan Acara Dihantar Pelayan untuk UI responsif.
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);
} Petua: Respons penstriman tiba sebagai Acara Dihantar Pelayan. Setiap ketulan mengandungi delta dengan kandungan separa.
Carian Web Terbina dalam
Shannon termasuk fungsi carian web terbina dalam yang tersedia secara automatik.
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 Petua Pro: Hasil carian web termasuk petikan. Shannon akan memetik sumber secara automatik.
Format Antropik
Shannon juga menyokong format API Mesej Anthropic.
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); Pengepala yang diperlukan: Format antropik memerlukan versi antropik: 2023-06-01.
SDK
serasiGunakan mana-mana OpenAI atau SDK Anthropic - cuma tukar URL asas.
SDK Serasi OpenAI
SDK Python
SDK Python OpenAI rasmi - berfungsi dengan Shannon
pip install openai SDK JavaScript / TypeScript
SDK OpenAI Node.js Rasmi - berfungsi dengan Shannon
npm install openai SDK Go
Pelanggan Community Go untuk API serasi OpenAI
go get github.com/sashabaranov/go-openai SDK Ruby
Pelanggan Ruby Komuniti untuk API serasi OpenAI
gem install ruby-openai SDK PHP
Pelanggan PHP komuniti untuk API serasi OpenAI
composer require openai-php/client SDK Rust
Pelanggan Async Rust untuk API serasi OpenAI
cargo add async-openai SDK Serasi Anthropic
SDK Python (Anthropic)
SDK Python Anthropic Rasmi - berfungsi dengan Shannon
pip install anthropic SDK TypeScript (Anthropic)
Official Anthropic TypeScript SDK - berfungsi dengan Shannon
npm install @anthropic-ai/sdk Pengendalian Ralat
Shannon menggunakan kod status HTTP standard dan mengembalikan mesej ralat terperinci.
400 Permintaan Buruk Format atau parameter permintaan tidak sah
401 tanpa kebenaran Kunci API tidak sah atau tiada
402 Kuota Melebihi Token atau kuota carian melebihi
429 Kadar Terhad Terlalu banyak permintaan, perlahankan
500 Ralat Pelayan Ralat dalaman, cuba semula kemudian
Format Respons Ralat
Respons Ralat
{
"error": {
"message": "Invalid API key provided",
"type": "authentication_error",
"code": "invalid_api_key"
}
}Changelog
LOGKemas kini dan peningkatan terkini pada API Shannon.
v2.1.0
2025-01-03 - baru Menambahkan model shannon-coder-1 untuk penyepaduan CLI Kod Claude
- baru Sistem kuota berasaskan panggilan untuk model Coder
- bertambah baik Kebolehpercayaan panggilan fungsi yang lebih baik
v2.0.0
2024-12-15 - baru Menambahkan keserasian API Mesej Anthropic
- baru Perlaksanaan alat berbilang pusingan (sehingga 10 lelaran)
- baru JSON Sokongan format respons skema
- bertambah baik Carian web dipertingkatkan dengan petikan yang lebih baik
v1.5.0
2024-11-20 - baru Menambah model shannon-deep-dapo untuk penaakulan yang kompleks
- baru Fungsi carian web terbina dalam
- bertambah baik Kependaman dikurangkan untuk respons penstriman
v1.0.0
2024-10-01 - baru Keluaran API awal
- baru Titik akhir penyelesaian sembang serasi OpenAI
- baru Fungsi panggilan sokongan
- baru Menstrim melalui Acara Dihantar Pelayan
Kunci API anda
Akses Gunakan token Pembawa untuk panggilan OpenAI atau X-API-Key + versi antropik.
YOUR_API_KEY Rahsiakan kunci API anda. Menjana semula mencipta kunci baharu dan membatalkan yang lama.
Penggunaan Anda
Lihat token dan penggunaan carian pada halaman ini apabila log masuk ke akaun anda.
-- Panggilan API
-- Token Digunakan
Shannon Coder (shannon-coder-1)
Kuota berasaskan panggilan untuk Shannon Coder (shannon-coder-1). Diset semula setiap 4 jam.
0 Panggilan Digunakan
0 Panggilan Berbaki
Bersedia untuk Membina?
Dapatkan kunci API anda dan mula membina dengan Shannon AI hari ini.
Carian popular:
Cuba kata kunci yang berbeza