Logo SHANNON A.I.
SHANNONA.I.
SembangHargaAPIPenyelidikanSyarikatPentest AIStartup Boost

Memuatkan antara muka Shannon...

Menyemak status...
Dokumentasi API

API Shannon

API AI kompatibel OpenAI & Anthropic dengan function calling, pencarian web, dan output terstruktur.

Dapatkan kunci API AndaCoba PlaygroundV2
Dokumentasi
  • Ringkasan
  • Kemampuan
  • Permulaan Pantas
  • Playground APIBaru
  • Autentikasi
  • Model
  • Panggilan Fungsi
  • Output Terstruktur
  • Penstriman
  • Pencarian Web Terintegrasi
  • Format Anthropic
  • SDK
  • Pengendalian Ralat
  • Catatan Perubahan

Shannon AI API Documentation

Ringkasan

Dokumen publik

Semua yang Anda butuhkan untuk rilis dengan API kompatibel OpenAI dan Anthropic dari Shannon.

URL asasSerasi dengan OpenAI
https://us-central1-shannonai.cloudfunctions.net/v1/chat/completions

Gunakan Chat Completions API dengan function calling dan streaming.

URL asasSerasi dengan Anthropic
https://us-central1-shannonai.cloudfunctions.net/v1/messages

Format Claude Messages dengan tools dan header anthropic-version.

HeaderAutentikasi
Kebenaran: Bearer <kunci-anda>

Atau gunakan X-API-Key + anthropic-version untuk panggilan gaya Claude.

AccessStatus
Public docs - Key required to call

Streaming, function calling, output berstruktur, dan carian web.

Senarai semak pelancaran
  • ✓
    Halakan SDK anda ke Shannon
    Tetapkan baseURL ke endpoint OpenAI atau Anthropic di atas.
    Setup
  • ✓
    Tambah API key anda
    Gunakan Bearer untuk OpenAI atau X-API-Key + anthropic-version.
    Security
  • ✓
    Aktifkan tools dan output berstruktur
    Menyokong OpenAI tools/functions, JSON schema dan web_search terbina dalam.
    Kemampuan
  • ✓
    Jejaki penggunaan
    Lihat penggunaan token dan carian di halaman ini selepas log masuk.
    Analytics

Kemampuan

OpenAI + Anthropic

Pengganti terus untuk API OpenAI dan Anthropic dengan sokongan native untuk tools, output berstruktur, dan carian web terbina dalam.

Pengganti drop‑in

Serasi

Berfungsi dengan SDK OpenAI dan Anthropic. Hanya tukar URL asas.

Panggilan Fungsi

Alat

Takrifkan alat, biarkan Shannon memanggilnya. Menyokong mod auto, forced, dan none.

Carian Web Terbina

Carian

Carian web masa nyata dengan petikan sumber. Tersedia secara automatik.

Output Berstruktur

JSON

Mod JSON dan penguatkuasaan Skema JSON untuk pengekstrakan data yang boleh dipercayai.

Alat Berbilang Pusingan

Agen

Gelung pelaksanaan fungsi automatik. Sehingga 10 iterasi bagi setiap permintaan.

Penstriman

Pantas

SSE untuk penstriman token masa nyata.

Permulaan Pantas

5 minit

Mulakan dalam tiga langkah. Shannon meniru klien OpenAI dan Anthropic.

1

Tetapkan URL asas anda

Gunakan endpoint serasi OpenAI.

https://us-central1-shannonai.cloudfunctions.net/v1/chat/completions
2

Tambah kunci API anda

Gunakan auth Bearer dalam pengepala Authorization.

3

Hantar mesej pertama anda

Pilih bahasa dan masukkan kunci anda.

Python
from openai import OpenAI
client = OpenAI(
api_key="YOUR_API_KEY",
base_url="https://us-central1-shannonai.cloudfunctions.net/v1"
)
response = client.chat.completions.create(
model="shannon-balanced-grpo",
messages=[
{"role": "system", "content": "You are a helpful assistant."},
{"role": "user", "content": "Hello, Shannon!"}
],
max_tokens=1024
)
print(response.choices[0].message.content)

Format respons

Respons berjaya
{
  "id": "chatcmpl-abc123",
  "object": "chat.completion",
  "created": 1234567890,
  "model": "shannon-balanced-grpo",
  "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
  }
}

Playground API

Baharu

Uji API Shannon terus dalam pelayar. Bina permintaan, jalankan, dan lihat respons masa nyata.

Claude-style API studio

One polished workbench for every public endpoint.

Switch between Chat Completions, Responses, and Messages without changing pages. The request body, auth header, stream parser, and SDK snippets all follow the selected protocol.

Endpoints3
ThemeCrail / Pampas
Latest response IDNot captured yet
Composer

Chat Completions

Live response

/v1/chat/completions

Chat Completions Idle 0 SSE events No reasoning block
response_idWaiting for a response...
Ready to test.

Pick an endpoint, shape the payload, and run the request to inspect the live output.

0
SDK snippets

Keep the request, headers, and client syntax aligned with the selected endpoint.

JSON
{
"model": "shannon-balanced-grpo",
"messages": [
{
"role": "system",
"content": "You are Shannon. Answer crisply, commercially, and with strong structure."
},
{
"role": "user",
"content": "Outline a clean launch plan for a new AI API aimed at startup founders."
}
],
"max_tokens": 1024,
"temperature": 0.7,
"stream": true
}

Autentikasi

Semua permintaan API memerlukan pengesahan menggunakan Shannon API key anda.

OpenAI Format (Recommended)

HTTP
Authorization: Bearer YOUR_API_KEY

Format Anthropic

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

Model

Shannon menawarkan beberapa model yang dioptimumkan untuk pelbagai use case.

shannon-balanced-grpoBalanced

Fast, efficient responses for everyday tasks

Konteks128K
Terbaik untukChat, Q&A, Content Generation
shannon-deep-dapoDeep

Advanced reasoning for complex problems

Konteks128K
Terbaik untukAnalysis, Research, Complex Tasks
shannon-coder-1Coder

Optimized for Claude Code CLI with call-based quota

Konteks128K
Terbaik untukCode Generation, Tool Use, CLI Integration
Call-based quota

Panggilan Fungsi

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://us-central1-shannonai.cloudfunctions.net/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-balanced-grpo",
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}")

Pilihan pemilihan alat

"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

Respons panggilan fungsi

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

Output Terstruktur

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://us-central1-shannonai.cloudfunctions.net/v1"
)
# Force JSON output with schema
response = client.chat.completions.create(
model="shannon-balanced-grpo",
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"}

Pilihan format respons

{"type": "json_object"}Force valid JSON output (no specific schema)
{"type": "json_schema", "json_schema": {...}}Force output matching your exact schema

Penstriman

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://us-central1-shannonai.cloudfunctions.net/v1"
)
# Enable streaming for real-time responses
stream = client.chat.completions.create(
model="shannon-balanced-grpo",
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)
Petua: Streaming responses arrive as Server-Sent Events. Each chunk contains a delta with partial content.

Pencarian Web Terintegrasi

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://us-central1-shannonai.cloudfunctions.net/v1"
)
# Web search is automatically available!
# Shannon will use it when needed for current information
response = client.chat.completions.create(
model="shannon-balanced-grpo",
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
Petua pro: Hasil carian web menyertakan petikan sumber. Shannon akan memetik sumber secara automatik.

Format Anthropic

Shannon juga menyokong format Anthropic Messages API.

https://us-central1-shannonai.cloudfunctions.net/v1/messages
Python
import anthropic
client = anthropic.Anthropic(
api_key="YOUR_API_KEY",
base_url="https://us-central1-shannonai.cloudfunctions.net/messages"
)
response = client.messages.create(
model="shannon-balanced-grpo",
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)
Header wajib: Anthropic format requires anthropic-version: 2023-06-01.

SDK

Serasi

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

OpenAI-Compatible SDKs

Python

Official OpenAI Python SDK - works with Shannon

pip install openai
View Docs
JavaScript / TypeScript

Official OpenAI Node.js SDK - works with Shannon

npm install openai
View Docs
Go

Community Go client for OpenAI-compatible APIs

go get github.com/sashabaranov/go-openai
View Docs
Ruby

Community Ruby client for OpenAI-compatible APIs

gem install ruby-openai
View Docs
PHP

Community PHP client for OpenAI-compatible APIs

composer require openai-php/client
View Docs
Rust

Async Rust client for OpenAI-compatible APIs

cargo add async-openai
View Docs

Anthropic-Compatible SDKs

Python (Anthropic)

Official Anthropic Python SDK - works with Shannon

pip install anthropic
View Docs
TypeScript (Anthropic)

Official Anthropic TypeScript SDK - works with Shannon

npm install @anthropic-ai/sdk
View Docs

Pengendalian Ralat

Shannon menggunakan kod status HTTP standard dan mengembalikan mesej ralat terperinci.

400Permintaan Tidak SahFormat atau parameter permintaan tidak sah
401Tidak DibenarkanKunci API tidak sah atau tiada
402Kuota MelebihiKuota token atau carian melebihi
429Had KadarTerlalu banyak permintaan, perlahan sedikit
500Ralat PelayanRalat dalaman, cuba lagi kemudian

Format Respons Ralat

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

Catatan Perubahan

Recent updates and improvements to the Shannon API.

v2.1.0
2025-01-03
  • BaruAdded shannon-coder-1 model for Claude Code CLI integration
  • BaruCall-based quota system for Coder model
  • ImprovedImproved function calling reliability
v2.0.0
2024-12-15
  • BaruAdded Anthropic Messages API compatibility
  • BaruMulti-turn tool execution (up to 10 iterations)
  • BaruJSON Schema response format support
  • ImprovedEnhanced web search with better citations
v1.5.0
2024-11-20
  • BaruAdded shannon-deep-dapo model for complex reasoning
  • BaruBuilt-in web_search function
  • ImprovedReduced latency for streaming responses
v1.0.0
2024-10-01
  • BaruInitial API release
  • BaruOpenAI-compatible chat completions endpoint
  • BaruFunction calling support
  • BaruStreaming via Server-Sent Events

Siap membangun?

Get your API key and start building with Shannon AI today.

Dapatkan kunci APILihat Harga