Dokumentasi API Shannon AI

Ringkasan

Dokumen publik

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

URL dasar Kompatibel dengan OpenAI

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

Gunakan Chat Completions API dengan function calling dan streaming.

URL dasar Kompatibel dengan Anthropic

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

Format Claude Messages dengan tools dan header anthropic-version.

Header Autentikasi

Otorisasi: Bearer <kunci-anda>

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

Access Status

Public docs - Key required to call

Streaming, function calling, output terstruktur, dan pencarian web.

Checklist peluncuran

+

Arahkan SDK Anda ke Shannon

Set baseURL ke endpoint OpenAI atau Anthropic di atas.

Setup
+

Tambahkan API key Anda

Gunakan Bearer untuk OpenAI atau X-API-Key + anthropic-version.

Security
+

Aktifkan tools dan output terstruktur

Mendukung OpenAI tools/functions, JSON schema, dan web_search bawaan.

Kemampuan
+

Pantau penggunaan

Lihat konsumsi token dan pencarian di halaman ini saat Anda login.

Analytics

Kemampuan

OpenAI + Anthropic

Pengganti langsung untuk API OpenAI dan Anthropic dengan dukungan bawaan untuk tools, output terstruktur, dan pencarian web.

Pengganti langsung

Kompatibel

Berfungsi dengan SDK OpenAI dan Anthropic. Cukup ganti base URL.

Pemanggilan fungsi

Alat

Tentukan alat, biarkan Shannon memanggilnya. Mendukung mode auto, paksa, dan none.

Pencarian web bawaan

Pencarian

Pencarian web real‑time dengan sitasi sumber. Tersedia otomatis.

Output terstruktur

JSON

Mode JSON dan penegakan JSON Schema untuk ekstraksi data yang andal.

Alat multi‑putaran

Agentik

Loop eksekusi fungsi otomatis. Hingga 10 iterasi per permintaan.

Streaming

Cepat

Server‑sent events untuk streaming token secara real‑time.

Mulai cepat

5 menit

Mulai dalam tiga langkah. Shannon mencerminkan klien OpenAI dan Anthropic.

Atur base URL Anda

Gunakan endpoint yang kompatibel dengan OpenAI.

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

Tambahkan kunci API Anda

Gunakan autentikasi Bearer di header Authorization.

Kirim pesan pertama Anda

Pilih bahasa dan ganti dengan kunci Anda.

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 respons

Respons berhasil

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

Baru

Uji API Shannon langsung di browser Anda. Buat permintaan, jalankan, dan lihat respons secara 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.

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

Coba Playground V2 Dapatkan kunci API Anda

Autentikasi

Semua permintaan API memerlukan autentikasi menggunakan API key Shannon 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 dioptimalkan untuk berbagai use case.

shannon-1.6-lite Shannon 1.6 Lite

Fast, efficient responses for everyday tasks

Konteks 128K

Terbaik untuk Chat, Q&A, Content Generation

shannon-1.6-pro Shannon 1.6 Pro

Advanced reasoning for complex problems

Konteks 128K

Terbaik untuk Analysis, Research, Complex Tasks

shannon-2-lite Shannon 2 Lite

Konteks 128K

Terbaik untuk

shannon-2-pro Shannon 2 Pro

Konteks 128K

Terbaik untuk

shannon-coder-1 Shannon Coder

Optimized for Claude Code CLI with call-based quota

Konteks 128K

Terbaik untuk Code Generation, Tool Use, CLI Integration

Call-based quota

Pemanggilan 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://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);
}

Opsi 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 pemanggilan 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://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" }

Opsi format respons

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

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

Streaming

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

Tips: 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://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

Tips pro: Hasil pencarian web menyertakan sitasi. Shannon akan mengutip sumber secara otomatis.

Format Anthropic

Shannon juga mendukung format Messages API milik 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);

Header wajib: Anthropic format requires anthropic-version: 2023-06-01.

SDK

Kompatibel

Use any OpenAI or Anthropic SDK - just change the 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 ->

Penanganan kesalahan

Shannon menggunakan kode status HTTP standar dan mengembalikan pesan kesalahan rinci.

400 Permintaan tidak valid Format atau parameter permintaan tidak valid

401 Tidak diizinkan Kunci API tidak valid atau hilang

402 Kuota terlampaui Kuota token atau pencarian terlampaui

429 Dibatasi Terlalu banyak permintaan, perlambat

500 Kesalahan server Kesalahan internal, coba lagi nanti

Format respons kesalahan

Respons kesalahan

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

Catatan Perubahan

LOG

Recent updates and improvements to the Shannon API.

v2.1.0

2025-01-03

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

v2.0.0

2024-12-15

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

v1.5.0

2024-11-20

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

v1.0.0

2024-10-01

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

Kunci API Anda

Access

Gunakan Bearer untuk OpenAI atau X-API-Key + anthropic-version.

YOUR_API_KEY

Dapatkan kunci API Anda

Jaga kerahasiaan kunci API Anda. Membuat ulang akan membuat kunci baru dan menonaktifkan yang lama.

Penggunaan Anda

Lihat konsumsi token dan pencarian di halaman ini saat Anda login.

-- Panggilan API

-- Token digunakan

API Shannon

Ringkasan

Kemampuan

Pengganti langsung

Pemanggilan fungsi

Pencarian web bawaan

Output terstruktur

Alat multi‑putaran

Streaming

Mulai cepat

Atur base URL Anda

Tambahkan kunci API Anda

Kirim pesan pertama Anda

Format respons

Playground API

Chat, Responses, Messages

Stream live output

Reuse your key

Autentikasi

OpenAI Format (Recommended)

Format Anthropic

Model

Pemanggilan fungsi

Opsi pemilihan alat

Respons pemanggilan fungsi

Output Terstruktur

Opsi format respons

Streaming

Pencarian Web Terintegrasi

Format Anthropic

SDK

OpenAI-Compatible SDKs

Anthropic-Compatible SDKs

Penanganan kesalahan

Format respons kesalahan

Catatan Perubahan

Kunci API Anda

Penggunaan Anda

Shannon Coder (shannon-coder-1)

Siap membangun?

Shannon AI API Documentation

Ringkasan

Kemampuan

Pengganti langsung

Pemanggilan fungsi

Pencarian web bawaan

Output terstruktur

Alat multi‑putaran

Streaming

Mulai cepat

Atur base URL Anda

Tambahkan kunci API Anda

Kirim pesan pertama Anda

Format respons

Playground API

Chat, Responses, Messages

Stream live output

Reuse your key

Autentikasi

OpenAI Format (Recommended)

Format Anthropic

Model

Pemanggilan fungsi

Opsi pemilihan alat

Respons pemanggilan fungsi

Output Terstruktur

Opsi format respons

Streaming

Pencarian Web Terintegrasi

Format Anthropic

SDK

OpenAI-Compatible SDKs

Anthropic-Compatible SDKs

Penanganan kesalahan

Format respons kesalahan

Catatan Perubahan

Kunci API Anda

Penggunaan Anda

Shannon Coder (shannon-coder-1)

Siap membangun?