Imibhalo ye-API ye-Shannon AI

Uhlaka

Imibhalo yomphakathi

Konke okudingayo ukuqala nge-API ye-Shannon ehambisana ne-OpenAI ne-Anthropic.

URL OpenAI-Compatible

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

Sebenzisa i-Chat Completions API nge-function calling kanye ne-streaming.

URL Anthropic-Compatible

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

Ifomethi ye-Claude Messages enamatheki namakhanda e-anthropic-version.

HTTP Ukuqinisekisa

Authorization: Bearer <api-key>

Noma i-X-API-Key ne-anthropic-version kuma-calls esizinda se-Claude.

Ukufinyelela Isimo

Imibhalo yomphakathi - ukushaya kudinga ukhiye

Streaming, function calling, structured outputs, web search.

Uhlu lokwethula

+

Qondisa i-SDK yakho ku-Shannon

Setha i-baseURL kuma-endpoint we-OpenAI noma Anthropic ngenhla.

Ukusetha
+

Namathisela i-API key yakho

Sebenzisa ama-Bearer tokens kuma-OpenAI calls noma i-X-API-Key + anthropic-version.

Ukuphepha
+

Vumela amathuluzi ne-structured outputs

Isekela i-OpenAI tools/functions, i-JSON schema, ne-built-in web_search.

Amandla
+

Landela ukusetshenziswa

Bona ukusetshenziswa kwama-token nokusesha kuleli khasi uma ungenile.

Ukuhlaziya

Amandla

OpenAI + Anthropic

Drop-in replacement ye-OpenAI ne-Anthropic APIs, enokusekela amathuluzi, structured outputs, kanye ne-built-in web search.

Drop-in Replacement

Compatible

Isebenza nama-OpenAI ne-Anthropic SDKs. Shintsha i-base URL kuphela.

Ukubiza umsebenzi

Tools

Chaza amathuluzi, vumela uShannon uwabize. Isekela auto, forced, none modes.

Usesho lwewebhu

Sesha

Ukusesha kwewebhu ngesikhathi sangempela nezicaphuno zemithombo. Kutholakala ngokuzenzakalelayo.

Imiphumela ehlanganisiwe

JSON

Imodi ye-JSON ne-JSON Schema enforcement ukuze kukhishwe idatha ethembekile.

Multi-turn Tools

Agentic

Ama-loop okuzenzakalela wokusebenza kwefunction. Kuya ku-10 iterations ngesicelo.

Ukusakaza

Fast

Server-sent events zokusakaza ama-token ngesikhathi sangempela.

Isiqalo esisheshayo

5 imizuzu

Qala ngezinyathelo ezintathu. Shannon ilingisa amaklayenti e-OpenAI ne-Anthropic.

Setha i-base URL

Sebenzisa i-OpenAI-compatible endpoint.

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

Faka i-API key

Sebenzisa i-Bearer auth ku-Authorization header.

Thumela umlayezo wakho wokuqala

Khetha ulimi bese ushintsha ukhiye wakho.

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

Response format

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

API Playground

OKUSHA

Hlola i-Shannon API ngqo kusiphequluli. Yakha isicelo sakho, usiqhube, ubone impendulo ngesikhathi sangempela.

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.

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

Zama i-Playground V2 Thola i-API key yakho

Ukuqinisekisa

Zonke izicelo ze-API zidinga ukuqinisekiswa usebenzisa i-Shannon API key yakho.

OpenAI Format (kunconywe)

HTTP

Authorization: Bearer YOUR_API_KEY

Anthropic

HTTP

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

Amamodeli

Shannon inikezela ngamamodeli amaningi enzelwe izimo ezahlukene zokusebenzisa.

shannon-1.6-lite Shannon 1.6 Lite

Impendulo esheshayo nenempumelelo emisebenzini yansuku zonke

Isimo 128K

Yakhelwe Ochwepheshe Bokuphepha Ingxoxo, Q&A, Ukwakhiwa kokuqukethwe

shannon-1.6-pro Shannon 1.6 Pro

Ukucabanga okujulile ezinkingeni eziyinkimbinkimbi

Isimo 128K

Yakhelwe Ochwepheshe Bokuphepha Ukuhlaziya, Ucwaningo, Imisebenzi eyinkimbinkimbi

shannon-2-lite Shannon 2 Lite

Isimo 128K

Yakhelwe Ochwepheshe Bokuphepha

shannon-2-pro Shannon 2 Pro

Isimo 128K

Yakhelwe Ochwepheshe Bokuphepha

shannon-coder-1 Shannon Coder

Isetshenziswe ku-Claude Code CLI nge-call-based quota

Isimo 128K

Yakhelwe Ochwepheshe Bokuphepha Ukwenza ikhodi, Ukusebenzisa amathuluzi, CLI integration

Call-based quota

Ukubiza umsebenzi

Chaza amathuluzi uShannon angawabiza ukuze enze izenzo noma athole ulwazi.

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

Ukubiza umsebenzi

"auto" Imodeli izinquma ukuthi ibize umsebenzi yini (default)

"none" Khubaza function calling kulesi sicelo

{"type": "function", "function": {"name": "..."}} Phoqelela function call ethile

Response format

Uma imodeli ibiza umsebenzi

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

Imiphumela ehlanganisiwe

Phoqelela uShannon ukuthi aphendule nge-JSON evumelekile ehambisana ne-schema yakho.

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

Response format

{"type": "json_object"} Phoqelela i-JSON output evumelekile (ngaphandle kwe-schema ethile)

{"type": "json_schema", "json_schema": {...}} Phoqelela output ehambisana ne-schema yakho ngqo

Ukusakaza

Vumela streaming wama-token ngesikhathi sangempela nge-Server-Sent Events ukuze i-UI iphendule ngokushesha.

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

Ithiphu: Izimpendulo ze-streaming zifika njenge-Server-Sent Events. I-chunk ngayinye iqukethe i-delta enokuqukethwe okuyingxenye.

Usesho lwewebhu

Shannon inefunction web_search eyakhelwe ngaphakathi futhi itholakala ngokuzenzakalelayo.

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

Ithiphu: Imiphumela ye-web search inezicaphuno. Shannon izocaphuna imithombo ngokuzenzakalelayo.

Anthropic

Shannon iphinde isekele ifomethi ye-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);

Required: Ifomethi ye-Anthropic idinga anthropic-version: 2023-06-01.

SDKs

Compatible

Sebenzisa noma iyiphi i-OpenAI noma i-Anthropic SDK — shintsha i-base URL kuphela.

OpenAI-Compatible SDKs

SDK Python

Official OpenAI Python SDK — isebenza noShannon

pip install openai

Buka imibhalo ->

SDK JavaScript / TypeScript

Official OpenAI Node.js SDK — isebenza noShannon

npm install openai

Buka imibhalo ->

SDK Go

Community Go client ye-OpenAI-compatible APIs

go get github.com/sashabaranov/go-openai

Buka imibhalo ->

SDK Ruby

Community Ruby client ye-OpenAI-compatible APIs

gem install ruby-openai

Buka imibhalo ->

SDK PHP

Community PHP client ye-OpenAI-compatible APIs

composer require openai-php/client

Buka imibhalo ->

SDK Rust

Async Rust client ye-OpenAI-compatible APIs

cargo add async-openai

Buka imibhalo ->

Anthropic-Compatible SDKs

SDK Python (Anthropic)

Official Anthropic Python SDK — isebenza noShannon

pip install anthropic

Buka imibhalo ->

SDK TypeScript (Anthropic)

Official Anthropic TypeScript SDK — isebenza noShannon

npm install @anthropic-ai/sdk

Buka imibhalo ->

Ukuphathwa kwamaphutha

Shannon isebenzisa izinkomba ze-HTTP status ezijwayelekile futhi ibuyise imiyalezo yamaphutha eningiliziwe.

400 Bad Request Ifomethi yesicelo noma amapharamitha awavumelekile

401 Unauthorized I-API key ayilungile noma ayikho

402 Quota Exceeded I-quota ye-token noma yokusesha idlulile

429 Rate Limited Izicelo eziningi kakhulu, yehlisa ijubane

500 Server Error Iphutha langaphakathi, zama futhi kamuva

Error Response Format

Error Response

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

Ilokhi yezinguquko

LOG

Izibuyekezo zakamuva nokuthuthukiswa kwe-Shannon API.

v2.1.0

2025-01-03

OKUSHA Kwengezwe imodeli shannon-coder-1 yokuhlanganisa i-Claude Code CLI
OKUSHA Uhlelo lwe-quota olususelwa ku-call lwe-Coder model
Kuthuthukisiwe Kuthuthukiswe ukuthembeka kwe-function calling

v2.0.0

2024-12-15

OKUSHA Kwengezwe ukusekelwa kwe-Anthropic Messages API
OKUSHA Ukuqhutshwa kwamathuluzi amanyathelo amaningi (kuya ku-10 iterations)
OKUSHA Ukusekelwa kwe-JSON Schema response format
Kuthuthukisiwe Kuthuthukiswe web search ngezicaphuno ezingcono

v1.5.0

2024-11-20

OKUSHA Kwengezwe imodeli shannon-deep-dapo yezimvo eziyinkimbinkimbi
OKUSHA I-function web_search eyakhelwe ngaphakathi
Kuthuthukisiwe Kwehliswe ukubambezeleka kwe-streaming

v1.0.0

2024-10-01

OKUSHA Ukukhishwa kokuqala kwe-API
OKUSHA OpenAI-compatible chat completions endpoint
OKUSHA Ukusekelwa kwe-function calling
OKUSHA Streaming nge-Server-Sent Events

I-API key yakho

Ukufinyelela

Sebenzisa ama-Bearer tokens kuma-OpenAI calls noma i-X-API-Key + anthropic-version.

YOUR_API_KEY

Thola i-API key yakho

Gcina i-API key yakho iyimfihlo. Regenerate yakha i-key entsha futhi yenze endala ingasebenzi.

Ukusetshenziswa kwakho

Bona ukusetshenziswa kwama-token nokusesha kuleli khasi uma ungenile.

-- API Calls

-- Tokens Used

Shannon API

Uhlaka

Amandla

Drop-in Replacement

Ukubiza umsebenzi

Usesho lwewebhu

Imiphumela ehlanganisiwe

Multi-turn Tools

Ukusakaza

Isiqalo esisheshayo

Setha i-base URL

Faka i-API key

Thumela umlayezo wakho wokuqala

Response format

API Playground

Chat, Responses, Messages

Stream live output

Reuse your key

Ukuqinisekisa

OpenAI Format (kunconywe)

Anthropic

Amamodeli

Ukubiza umsebenzi

Ukubiza umsebenzi

Response format

Imiphumela ehlanganisiwe

Response format

Ukusakaza

Usesho lwewebhu

Anthropic

SDKs

OpenAI-Compatible SDKs

Anthropic-Compatible SDKs

Ukuphathwa kwamaphutha

Error Response Format

Ilokhi yezinguquko

I-API key yakho

Ukusetshenziswa kwakho

Shannon Coder (shannon-coder-1)

Usukulungele ukwakha?

Shannon AI API Documentation

Uhlaka

Amandla

Drop-in Replacement

Ukubiza umsebenzi

Usesho lwewebhu

Imiphumela ehlanganisiwe

Multi-turn Tools

Ukusakaza

Isiqalo esisheshayo

Setha i-base URL

Faka i-API key

Thumela umlayezo wakho wokuqala

Response format

API Playground

Chat, Responses, Messages

Stream live output

Reuse your key

Ukuqinisekisa

OpenAI Format (kunconywe)

Anthropic

Amamodeli

Ukubiza umsebenzi

Ukubiza umsebenzi

Response format

Imiphumela ehlanganisiwe

Response format

Ukusakaza

Usesho lwewebhu

Anthropic

SDKs

OpenAI-Compatible SDKs

Anthropic-Compatible SDKs

Ukuphathwa kwamaphutha

Error Response Format

Ilokhi yezinguquko

I-API key yakho

Ukusetshenziswa kwakho

Shannon Coder (shannon-coder-1)

Usukulungele ukwakha?