Akwụkwọ API Shannon AI

Nchịkọta

Public docs

Ihe niile ị chọrọ iji zipu site na API kwekọrọ na OpenAI na Anthropic nke Shannon.

URL OpenAI-Compatible

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

Use the Chat Completions API with function calling and streaming.

URL Anthropic-Compatible

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

Claude Messages format with tools and anthropic-version header.

HTTP Nyocha njirimara

Authorization: Bearer <api-key>

Or X-API-Key with anthropic-version for Claude-style calls.

Access Status

Public docs - Key required to call

Streaming, function calling, structured outputs, web search.

Launch checklist

+

Point your SDK at Shannon

Set baseURL to the OpenAI or Anthropic endpoints above.

Setup
+

Attach your API key

Use Bearer tokens for OpenAI calls or X-API-Key + anthropic-version.

Security
+

Enable tools & structured outputs

Supports OpenAI tools/functions, JSON schema, and built-in web_search.

Ikike
+

Track usage

View token and search consumption on this page when signed in to your account.

Analytics

Ikike

OpenAI + Anthropic

Nnọchi drop‑in maka OpenAI na Anthropic APIs nwere nkwado ngwa, mmepụta ahaziri, na ọchụchọ weebụ arụnyere.

Ndochite drop‑in

Kwekọrọ

Ọ na-arụ ọrụ na SDK OpenAI na Anthropic. Naanị gbanwee base URL.

Oku ọrụ

Ngwaọrụ

Kọwaa ngwaọrụ, mee ka Shannon kpọọ ha. Na-akwado auto, forced na none.

Nchọgharị weebụ arụnyere

Chọọ

Nchọgharị weebụ ozugbo na ntụaka isi mmalite. Dị nnọọ na-akpaghị aka.

Mmepụta akpụpụtara

JSON

Ụdị JSON na ime ka JSON Schema rụọ ọrụ maka iwepụta data kwụsie ike.

Ngwaọrụ ọtụtụ ntụgharị

Ajenti

Mgbanwe ọrụ na-akpaghị aka. Ruo ntụgharị 10 kwa arịrịọ.

Ntụgharị

Ngwa ngwa

Server‑sent events maka streaming token ozugbo.

Mmalite ngwa ngwa

minit 5

Malite n'ime nzọụkwụ atọ. Shannon na-eme ka ndị ahịa OpenAI na Anthropic dị ka ha.

Tọọ base URL gị

Jiri endpoint kwekọrọ na OpenAI.

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

Tinye API key gị

Jiri Bearer auth na isi Authorization.

Zipu ozi mbụ gị

Họrọ asụsụ ma tinye key gị.

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

Ụdị nzaghachi

Nzaghachi gara nke ọma

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

Ogige API

Ọhụrụ

Nwale Shannon API ozugbo na browser gị. Wuo arịrịọ, mee ka ọ gaa, hụ nzaghachi ozugbo.

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.

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

Nwale Playground V2 Nweta igodo API gị

Nyocha njirimara

Arịrịọ API niile chọrọ nkwenye site na igodo API Shannon gị.

OpenAI Format (Recommended)

HTTP

Authorization: Bearer YOUR_API_KEY

Anthropic

HTTP

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

Ụdị

Shannon na-enye ọtụtụ ụdị e mere ka ha kwekọọ na ọnọdụ ojiji dị iche.

shannon-1.6-lite Shannon 1.6 Lite

Fast, efficient responses for everyday tasks

Ọnọdụ 128K

Ewuru maka Ndị Ọkachamara Nchekwa Chat, Q&A, Content Generation

shannon-1.6-pro Shannon 1.6 Pro

Advanced reasoning for complex problems

Ọnọdụ 128K

Ewuru maka Ndị Ọkachamara Nchekwa Analysis, Research, Complex Tasks

shannon-2-lite Shannon 2 Lite

Ọnọdụ 128K

Ewuru maka Ndị Ọkachamara Nchekwa

shannon-2-pro Shannon 2 Pro

Ọnọdụ 128K

Ewuru maka Ndị Ọkachamara Nchekwa

shannon-coder-1 Shannon Coder

Optimized for Claude Code CLI with call-based quota

Ọnọdụ 128K

Ewuru maka Ndị Ọkachamara Nchekwa Code Generation, Tool Use, CLI Integration

Call-based quota

Oku ọrụ

Kọwaa ngwa Shannon nwere ike ịkpọ ka o mee omume ma ọ bụ nweta ozi.

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

Oku ọrụ

"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

Ụdị nzaghachi

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

Mmepụta ahaziri

Mee ka Shannon zaa JSON ziri ezi nke kwekọrọ na skema gị.

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

Ụdị nzaghachi

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

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

Nzipu ozugbo

Mee ka nkwụnye token n’oge‑n’eziokwu rụọ ọrụ site na Server‑Sent Events maka UI na‑azaghachi ngwa ngwa.

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.

Chọọ weebụ

Shannon nwere ọrụ web_search arụnyere nke dị ozugbo.

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

Ndumodu: Web search results include citations. Shannon will automatically cite sources.

Anthropic

Shannon na-akwado format Messages API nke 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);

Required: Anthropic format requires anthropic-version: 2023-06-01.

SDKs

Kwekọrọ

Jiri SDK OpenAI ma ọ bụ Anthropic ọ bụla — naanị gbanwee 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 ->

Njikwa njehie

Shannon na-eji koodu ọnọdụ HTTP ọkọlọtọ wee weghachite ozi njehie zuru ezu.

400 Arịrịọ ọjọọ Ụdị arịrịọ ma ọ bụ paramaeta ezighi ezi

401 Enweghị ikike API key ezighi ezi ma ọ bụ efu

402 Quota gafere Quota token ma ọ bụ nchọ gafere

429 Ekwesịrị ime ka ọnụego belata Arịrịọ karịrị, belata ọsọ

500 Njehie sava Njehie n'ime, nwalee ọzọ mgbe e mesịrị

Ụdị nzaghachi njehie

Nzaghachi njehie

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

Ndepụta mgbanwe

LOG

Mmelite na mmezi ọhụrụ na Shannon API.

v2.1.0

2025-01-03

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

v2.0.0

2024-12-15

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

v1.5.0

2024-11-20

Ọhụrụ Added shannon-deep-dapo model for complex reasoning
Ọhụrụ Built-in web_search function
Improved Reduced latency for streaming responses

v1.0.0

2024-10-01

Ọhụrụ Initial API release
Ọhụrụ OpenAI-compatible chat completions endpoint
Ọhụrụ Function calling support
Ọhụrụ Streaming via Server-Sent Events

API key gị

Access

Use Bearer tokens for OpenAI calls or X-API-Key + anthropic-version.

YOUR_API_KEY

Nweta igodo API gị

Chekwaa API key gị n'ihe nzuzo. Imegharịa na-emepụta key ọhụrụ ma na-eme ka nke ochie ghara ịdị irè.

Ojiji gị

View token and search consumption on this page when signed in to your account.

-- Oku API

-- Token eji

Shannon API

Nchịkọta

Ikike

Ndochite drop‑in

Oku ọrụ

Nchọgharị weebụ arụnyere

Mmepụta akpụpụtara

Ngwaọrụ ọtụtụ ntụgharị

Ntụgharị

Mmalite ngwa ngwa

Tọọ base URL gị

Tinye API key gị

Zipu ozi mbụ gị

Ụdị nzaghachi

Ogige API

Chat, Responses, Messages

Stream live output

Reuse your key

Nyocha njirimara

OpenAI Format (Recommended)

Anthropic

Ụdị

Oku ọrụ

Oku ọrụ

Ụdị nzaghachi

Mmepụta ahaziri

Ụdị nzaghachi

Nzipu ozugbo

Chọọ weebụ

Anthropic

SDKs

OpenAI-Compatible SDKs

Anthropic-Compatible SDKs

Njikwa njehie

Ụdị nzaghachi njehie

Ndepụta mgbanwe

API key gị

Ojiji gị

Shannon Coder (shannon-coder-1)

Kwadebere ịrụ?

Shannon AI API Documentation

Nchịkọta

Ikike

Ndochite drop‑in

Oku ọrụ

Nchọgharị weebụ arụnyere

Mmepụta akpụpụtara

Ngwaọrụ ọtụtụ ntụgharị

Ntụgharị

Mmalite ngwa ngwa

Tọọ base URL gị

Tinye API key gị

Zipu ozi mbụ gị

Ụdị nzaghachi

Ogige API

Chat, Responses, Messages

Stream live output

Reuse your key

Nyocha njirimara

OpenAI Format (Recommended)

Anthropic

Ụdị

Oku ọrụ

Oku ọrụ

Ụdị nzaghachi

Mmepụta ahaziri

Ụdị nzaghachi

Nzipu ozugbo

Chọọ weebụ

Anthropic

SDKs

OpenAI-Compatible SDKs

Anthropic-Compatible SDKs

Njikwa njehie

Ụdị nzaghachi njehie

Ndepụta mgbanwe

API key gị

Ojiji gị

Shannon Coder (shannon-coder-1)

Kwadebere ịrụ?