Dokumentasyon ng Shannon AI API

Pangkalahatang-ideya

Public docs

Lahat ng kailangan mo para mag‑launch gamit ang OpenAI at Anthropic compatible API ng Shannon.

URL Compatible sa OpenAI

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

Gamitin ang Chat Completions API na may function calling at streaming.

URL Compatible sa Anthropic

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

Claude Messages format na may tools at anthropic-version header.

Mga header Pagpapatunay

Awtorisasyon: Bearer <iyong-key>

O gumamit ng X-API-Key + anthropic-version para sa Claude-style na mga tawag.

Access Status

Public docs - Key required to call

Streaming, function calling, structured outputs, at web search.

Launch checklist

+

Ituro ang iyong SDK sa Shannon

Itakda ang baseURL sa OpenAI o Anthropic endpoint sa itaas.

Setup
+

Idagdag ang iyong API key

Gamitin ang Bearer para sa OpenAI o X-API-Key + anthropic-version.

Security
+

I-enable ang tools at structured outputs

Sinusuportahan ang OpenAI tools/functions, JSON schema, at built-in na web_search.

Kakayahan
+

I-track ang paggamit

Tingnan ang paggamit ng token at search sa page na ito pagkatapos mag-login.

Analytics

Kakayahan

OpenAI + Anthropic

Drop‑in na kapalit para sa OpenAI at Anthropic APIs na may suporta sa tools, structured outputs, at built‑in na web search.

Drop‑in na kapalit

Katugma

Gumagana sa OpenAI at Anthropic SDKs. Palitan lang ang base URL.

Pagtawag ng Function

Mga Tool

I‑define ang mga tool at hayaang tawagin ni Shannon. Suportado ang auto, forced, at none na mode.

Built‑in Web Search

Paghahanap

Real‑time web search na may source citations. Awtomatikong available.

Naka‑istrukturang Output

JSON

JSON mode at JSON Schema enforcement para sa maaasahang data extraction.

Multi‑turn Tools

Ahen

Awtomatikong function execution loops. Hanggang 10 iterations bawat request.

Pag‑stream

Mabilis

Server‑sent events para sa real‑time token streaming.

Mabilis na Pagsisimula

5 minuto

Magsimula sa tatlong hakbang. Ginagaya ni Shannon ang OpenAI at Anthropic clients.

Itakda ang base URL

Gumamit ng OpenAI‑compatible endpoint.

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

Idagdag ang API key

Gumamit ng Bearer auth sa Authorization header.

Ipadala ang unang mensahe

Pumili ng wika at ilagay ang iyong key.

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

Format ng response

Matagumpay na 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
  }
}

Playground ng API

Bago

Subukan ang Shannon API diretso sa browser. Bumuo ng request, patakbuhin, at makita ang response nang real‑time.

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.

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

Subukan ang Playground V2 Kunin ang iyong API key

Pagpapatunay

Lahat ng API request ay nangangailangan ng authentication gamit ang Shannon API key mo.

OpenAI Format (Recommended)

HTTP

Authorization: Bearer YOUR_API_KEY

Anthropic

HTTP

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

Mga modelo

Nag-aalok ang Shannon ng maraming modelong na‑optimize para sa iba’t ibang use case.

shannon-1.6-lite Shannon 1.6 Lite

Fast, efficient responses for everyday tasks

Konteksto 128K

Pinakamainam para sa Chat, Q&A, Content Generation

shannon-1.6-pro Shannon 1.6 Pro

Advanced reasoning for complex problems

Konteksto 128K

Pinakamainam para sa Analysis, Research, Complex Tasks

shannon-2-lite Shannon 2 Lite

Konteksto 128K

Pinakamainam para sa

shannon-2-pro Shannon 2 Pro

Konteksto 128K

Pinakamainam para sa

shannon-coder-1 Shannon Coder

Optimized for Claude Code CLI with call-based quota

Konteksto 128K

Pinakamainam para sa Code Generation, Tool Use, CLI Integration

Call-based quota

Function calling

Tukuyin ang mga tool na puwedeng tawagin ni Shannon para gumawa ng aksyon o kumuha ng impormasyon.

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

Mga opsyon sa pagpili ng tool

"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

Tugon sa pagtawag ng function

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

Structured outputs

Pilitin si Shannon na magbalik ng valid JSON na tumutugma sa schema mo.

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

Mga opsyon sa format ng tugon

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

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

Pag‑stream

I‑enable ang real‑time token streaming gamit ang Server‑Sent Events para sa responsive na UI.

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

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

Web search

May built‑in web_search function ang Shannon na awtomatikong 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

Pro tip: May kasamang citations ang web search results. Awtomatikong mag-cite ng sources si Shannon.

Anthropic

Sinusuportahan din ng Shannon ang Anthropic Messages API format.

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

Kinakailangang header: Anthropic format requires anthropic-version: 2023-06-01.

SDKs

Katugma

Gumamit ng anumang OpenAI o Anthropic SDK — palitan lang ang 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 ->

Paghawak ng Error

Gumagamit si Shannon ng standard HTTP status codes at nagbabalik ng detalyadong error messages.

400 Maling Kahilingan Invalid request format o parameters

401 Hindi Awtorisado Invalid o nawawalang API key

402 Lumampas sa Quota Lumagpas sa token o search quota

429 Nilimitahan ang Rate Masyadong maraming request, bagalan

500 Error sa Server Internal error, subukan muli mamaya

Format ng Error Response

Halimbawa ng Error

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

Tala ng pagbabago

LOG

Mga pinakabagong update at improvements sa Shannon API.

v2.1.0

2025-01-03

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

v2.0.0

2024-12-15

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

v1.5.0

2024-11-20

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

v1.0.0

2024-10-01

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

Ang iyong API Key

Access

Gamitin ang Bearer para sa OpenAI o X-API-Key + anthropic-version.

YOUR_API_KEY

Kunin ang iyong API key

Panatilihing lihim ang API key. Ang pag‑regenerate ay gagawa ng bagong key at mag‑i‑invalidate ng luma.

Ang iyong paggamit

Tingnan ang paggamit ng token at search sa page na ito pagkatapos mag-login.

-- Mga Tawag sa API

-- Mga Token na Nagamit

Shannon API

Pangkalahatang-ideya

Kakayahan

Drop‑in na kapalit

Pagtawag ng Function

Built‑in Web Search

Naka‑istrukturang Output

Multi‑turn Tools

Pag‑stream

Mabilis na Pagsisimula

Itakda ang base URL

Idagdag ang API key

Ipadala ang unang mensahe

Format ng response

Playground ng API

Chat, Responses, Messages

Stream live output

Reuse your key

Pagpapatunay

OpenAI Format (Recommended)

Anthropic

Mga modelo

Function calling

Mga opsyon sa pagpili ng tool

Tugon sa pagtawag ng function

Structured outputs

Mga opsyon sa format ng tugon

Pag‑stream

Web search

Anthropic

SDKs

OpenAI-Compatible SDKs

Anthropic-Compatible SDKs

Paghawak ng Error

Format ng Error Response

Tala ng pagbabago

Ang iyong API Key

Ang iyong paggamit

Shannon Coder (shannon-coder-1)

Handa nang bumuo?

Shannon AI API Documentation

Pangkalahatang-ideya

Kakayahan

Drop‑in na kapalit

Pagtawag ng Function

Built‑in Web Search

Naka‑istrukturang Output

Multi‑turn Tools

Pag‑stream

Mabilis na Pagsisimula

Itakda ang base URL

Idagdag ang API key

Ipadala ang unang mensahe

Format ng response

Playground ng API

Chat, Responses, Messages

Stream live output

Reuse your key

Pagpapatunay

OpenAI Format (Recommended)

Anthropic

Mga modelo

Function calling

Mga opsyon sa pagpili ng tool

Tugon sa pagtawag ng function

Structured outputs

Mga opsyon sa format ng tugon

Pag‑stream

Web search

Anthropic

SDKs

OpenAI-Compatible SDKs

Anthropic-Compatible SDKs

Paghawak ng Error

Format ng Error Response

Tala ng pagbabago

Ang iyong API Key

Ang iyong paggamit

Shannon Coder (shannon-coder-1)

Handa nang bumuo?