Dogfennaeth API Shannon AI

Trosolwg

Public docs

Popeth sydd ei angen i lansio gyda API cydnaws OpenAI ac Anthropic 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 Dilysu

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.

Galluoedd
+

Track usage

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

Analytics

Galluoedd

OpenAI + Anthropic

Disodli uniongyrchol i OpenAI ac Anthropic gyda chefnogaeth frodorol i offer, allbynnau strwythuredig a chwilio gwe adeiledig.

Amnewid drop‑in

Cydnaws

Yn gweithio gyda SDK OpenAI ac Anthropic. Newidiwch yr URL sylfaen yn unig.

Galw swyddogaethau

Offer

Diffiniwch offer, gadewch i Shannon eu galw. Yn cefnogi moddau auto, forced a none.

Chwiliad gwe adeiledig

Chwilio

Chwiliad gwe amser real gyda dyfyniadau ffynonellau. Ar gael yn awtomatig.

Allbynnau strwythuredig

JSON

Modd JSON a gorfodi JSON Schema ar gyfer tynnu data dibynadwy.

Offer aml‑dro

Asiant

Dolennu gweithrediad swyddogaeth awtomatig. Hyd at 10 iteriad fesul cais.

Ffrydio

Cyflym

Server‑sent events ar gyfer ffrydio token amser real.

Cychwyn cyflym

5 munud

Dechreuwch mewn tri cham. Mae Shannon yn efelychu cleientiaid OpenAI ac Anthropic.

Gosodwch eich URL sylfaen

Defnyddiwch endpoint sy’n gydnaws ag OpenAI.

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

Ychwanegwch eich API key

Defnyddiwch Bearer auth yn y pennawd Authorization.

Anfonwch eich neges gyntaf

Dewiswch iaith a rhowch eich allwedd.

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

Fformat ymateb

Ymateb llwyddiannus

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

Newydd

Profi API Shannon yn uniongyrchol yn eich porwr. Adeiladwch y cais, rhedwch ef, a gweld yr ymateb mewn amser real.

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.

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

Rhowch gynnig ar y Playground V2 Cael eich allwedd API

Dilysu

Mae pob cais API yn gofyn am ddilysu gan ddefnyddio eich allwedd API Shannon.

OpenAI Format (Recommended)

HTTP

Authorization: Bearer YOUR_API_KEY

Anthropic

HTTP

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

Modelau

Mae Shannon yn cynnig sawl model wedi'u optimeiddio ar gyfer gwahanol achosion defnydd.

shannon-1.6-lite Shannon 1.6 Lite

Fast, efficient responses for everyday tasks

Cyd-destun 128K

Wedi'i Adeiladu ar gyfer Gweithwyr Diogelwch Proffesiynol Chat, Q&A, Content Generation

shannon-1.6-pro Shannon 1.6 Pro

Advanced reasoning for complex problems

Cyd-destun 128K

Wedi'i Adeiladu ar gyfer Gweithwyr Diogelwch Proffesiynol Analysis, Research, Complex Tasks

shannon-2-lite Shannon 2 Lite

Cyd-destun 128K

Wedi'i Adeiladu ar gyfer Gweithwyr Diogelwch Proffesiynol

shannon-2-pro Shannon 2 Pro

Cyd-destun 128K

Wedi'i Adeiladu ar gyfer Gweithwyr Diogelwch Proffesiynol

shannon-coder-1 Shannon Coder

Optimized for Claude Code CLI with call-based quota

Cyd-destun 128K

Wedi'i Adeiladu ar gyfer Gweithwyr Diogelwch Proffesiynol Code Generation, Tool Use, CLI Integration

Call-based quota

Galw swyddogaeth

Diffiniwch offer y gall Shannon eu galw i gyflawni gweithredoedd neu adfer gwybodaeth.

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

Galw swyddogaeth

"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

Fformat ymateb

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

Allbynnau strwythuredig

Gorfodwch Shannon i ymateb gyda JSON dilys sy'n cyfateb i'ch sgema.

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

Fformat ymateb

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

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

Ffrydio

Galluogi ffrydio tocynnau amser real gyda Server‑Sent Events ar gyfer UI ymatebol.

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.

Chwilio gwe

Mae Shannon yn cynnwys swyddogaeth web_search adeiledig sydd ar gael yn awtomatig.

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

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

Anthropic

Mae Shannon hefyd yn cefnogi fformat Messages API 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

Cydnaws

Defnyddiwch unrhyw SDK OpenAI neu Anthropic — dim ond newid yr URL sylfaenol.

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

Rheoli gwallau

Mae Shannon yn defnyddio codau statws HTTP safonol ac yn dychwelyd negeseuon gwall manwl.

400 Cais gwael Fformat cais neu baramedrau annilys

401 Heb awdurdod API key annilys neu ar goll

402 Cwota wedi’i ragori Cwota tocynnau neu chwilio wedi’i ragori

429 Cyfyngiad cyfradd Gormod o geisiadau, arafwch

500 Gwall gweinydd Gwall mewnol, ceisiwch eto’n hwyrach

Fformat ymateb gwall

Ymateb gwall

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

Cofnod newidiadau

LOG

Diweddariadau a gwelliannau diweddar i API Shannon.

v2.1.0

2025-01-03

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

v2.0.0

2024-12-15

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

v1.5.0

2024-11-20

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

v1.0.0

2024-10-01

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

Eich API key

Access

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

YOUR_API_KEY

Cael eich allwedd API

Cadwch eich API key yn gyfrinachol. Mae ad‑genhedlu’n creu allwedd newydd ac yn annilysu’r hen un.

Eich defnydd

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

-- Galwadau API

-- Tocynnau a ddefnyddiwyd

Shannon API

Trosolwg

Galluoedd

Amnewid drop‑in

Galw swyddogaethau

Chwiliad gwe adeiledig

Allbynnau strwythuredig

Offer aml‑dro

Ffrydio

Cychwyn cyflym

Gosodwch eich URL sylfaen

Ychwanegwch eich API key

Anfonwch eich neges gyntaf

Fformat ymateb

Playground API

Chat, Responses, Messages

Stream live output

Reuse your key

Dilysu

OpenAI Format (Recommended)

Anthropic

Modelau

Galw swyddogaeth

Galw swyddogaeth

Fformat ymateb

Allbynnau strwythuredig

Fformat ymateb

Ffrydio

Chwilio gwe

Anthropic

SDKs

OpenAI-Compatible SDKs

Anthropic-Compatible SDKs

Rheoli gwallau

Fformat ymateb gwall

Cofnod newidiadau

Eich API key

Eich defnydd

Shannon Coder (shannon-coder-1)

Yn barod i adeiladu?

Shannon AI API Documentation

Trosolwg

Galluoedd

Amnewid drop‑in

Galw swyddogaethau

Chwiliad gwe adeiledig

Allbynnau strwythuredig

Offer aml‑dro

Ffrydio

Cychwyn cyflym

Gosodwch eich URL sylfaen

Ychwanegwch eich API key

Anfonwch eich neges gyntaf

Fformat ymateb

Playground API

Chat, Responses, Messages

Stream live output

Reuse your key

Dilysu

OpenAI Format (Recommended)

Anthropic

Modelau

Galw swyddogaeth

Galw swyddogaeth

Fformat ymateb

Allbynnau strwythuredig

Fformat ymateb

Ffrydio

Chwilio gwe

Anthropic

SDKs

OpenAI-Compatible SDKs

Anthropic-Compatible SDKs

Rheoli gwallau

Fformat ymateb gwall

Cofnod newidiadau

Eich API key

Eich defnydd

Shannon Coder (shannon-coder-1)

Yn barod i adeiladu?