Shannon AI API Dokümantasyonu

Genel Bakış

Herkese açık dokümanlar

Shannon'un OpenAI ve Anthropic uyumlu API'siyle yayınlamak için ihtiyacınız olan her şey.

Temel URL OpenAI ile uyumlu

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

Chat Completions API'yi function calling ve streaming ile kullanın.

Temel URL Anthropic ile uyumlu

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

Tools ve anthropic-version başlığı ile Claude Messages formatı.

Başlıklar Kimlik Doğrulama

Yetkilendirme: Bearer <anahtariniz>

Veya Claude tarzı çağrılar için anthropic-version ile X-API-Key kullanın.

Access Status

Public docs - Key required to call

Streaming, function calling, yapılandırılmış çıktılar ve web araması.

Yayına alma kontrol listesi

+

SDK'nızı Shannon'a yönlendirin

baseURL'yi yukarıdaki OpenAI veya Anthropic endpoint'ine ayarlayın.

Setup
+

API anahtarınızı ekleyin

OpenAI için Bearer veya X-API-Key + anthropic-version kullanın.

Security
+

Tools ve yapılandırılmış çıktıları etkinleştirin

OpenAI tools/functions, JSON schema ve yerleşik web_search desteklenir.

Yetenekler
+

Kullanımı takip edin

Hesabınıza giriş yaptığınızda bu sayfada token ve arama kullanımını görüntüleyin.

Analytics

Yetenekler

OpenAI + Anthropic

OpenAI ve Anthropic API'leri için tools, yapılandırılmış çıktılar ve yerleşik web araması desteğiyle doğrudan yedek.

Doğrudan değişim

Uyumlu

OpenAI ve Anthropic SDK’larıyla çalışır. Sadece base URL’yi değiştirin.

Fonksiyon çağrısı

Araçlar

Araçları tanımlayın, Shannon çağırısın. auto, forced ve none modlarını destekler.

Yerleşik web araması

Arama

Kaynak alıntılarıyla gerçek zamanlı web araması. Otomatik olarak kullanılabilir.

Yapılandırılmış çıktılar

JSON

JSON modu ve JSON Schema zorlamasıyla güvenilir veri çıkarımı.

Çok turlu araçlar

Ajanik

Otomatik fonksiyon yürütme döngüleri. İstek başına 10 iterasyona kadar.

Akış

Hızlı

Gerçek zamanlı token streaming için Server‑Sent Events.

Hızlı başlangıç

5 dakika

Üç adımda başlayın. Shannon, OpenAI ve Anthropic istemcilerini yansıtır.

Base URL’nizi ayarlayın

OpenAI uyumlu endpoint’i kullanın.

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

API anahtarınızı ekleyin

Authorization başlığında Bearer kimlik doğrulamasını kullanın.

İlk mesajınızı gönderin

Bir dil seçin ve anahtarınızı yerleştirin.

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

Yanıt formatı

Başarılı yanıt

{
  "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 Oyun Alanı

Yeni

Shannon API’yi doğrudan tarayıcıda test edin. İsteği oluşturun, çalıştırın ve yanıtı gerçek zamanlı görün.

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.

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

Playground'u dene V2 API anahtarı al

Kimlik Doğrulama

Tüm API istekleri Shannon API anahtarınızla kimlik doğrulama gerektirir.

OpenAI Format (Recommended)

HTTP

Authorization: Bearer YOUR_API_KEY

Anthropic Biçimi

HTTP

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

Modeller

Shannon, farklı kullanım senaryoları için optimize edilmiş birden fazla model sunar.

shannon-1.6-lite Shannon 1.6 Lite

Fast, efficient responses for everyday tasks

Bağlam 128K

En iyi kullanım Chat, Q&A, Content Generation

shannon-1.6-pro Shannon 1.6 Pro

Advanced reasoning for complex problems

Bağlam 128K

En iyi kullanım Analysis, Research, Complex Tasks

shannon-2-lite Shannon 2 Lite

Bağlam 128K

En iyi kullanım

shannon-2-pro Shannon 2 Pro

Bağlam 128K

En iyi kullanım

shannon-coder-1 Shannon Coder

Optimized for Claude Code CLI with call-based quota

Bağlam 128K

En iyi kullanım Code Generation, Tool Use, CLI Integration

Call-based quota

Fonksiyon Çağırma

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

Araç seçimi seçenekleri

"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

Fonksiyon çağrısı yanıtı

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

Yapılandırılmış Çıktılar

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

Yanıt biçimi seçenekleri

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

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

Akış

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

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

Yerleşik Web Arama

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

Pro İpucu: Web arama sonuçları kaynak içerir. Shannon kaynakları otomatik olarak alıntılar.

Anthropic Biçimi

Shannon, Anthropic'in Messages API formatını da destekler.

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

Gerekli başlık: Anthropic format requires anthropic-version: 2023-06-01.

SDK'lar

Uyumlu

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

Hata yönetimi

Shannon standart HTTP durum kodlarını kullanır ve ayrıntılı hata mesajları döndürür.

400 Geçersiz istek Geçersiz istek biçimi veya parametreler

401 Yetkisiz Geçersiz veya eksik API anahtarı

402 Kota aşıldı Token veya arama kotası aşıldı

429 Hız sınırlaması Çok fazla istek, yavaşlayın

500 Sunucu hatası Dahili hata, sonra tekrar deneyin

Hata yanıtı formatı

Hata yanıtı

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

Değişiklik Günlüğü

LOG

Recent updates and improvements to the Shannon API.

v2.1.0

2025-01-03

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

v2.0.0

2024-12-15

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

v1.5.0

2024-11-20

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

v1.0.0

2024-10-01

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

API Anahtarınız

Access

OpenAI için Bearer veya X-API-Key + anthropic-version kullanın.

YOUR_API_KEY

API anahtarı al

API anahtarınızı gizli tutun. Yeniden oluşturma yeni bir anahtar üretir ve eskisini geçersiz kılar.

Kullanımınız

Hesabınıza giriş yaptığınızda bu sayfada token ve arama kullanımını görüntüleyin.

-- API çağrıları

-- Kullanılan tokenlar

Shannon API

Genel Bakış

Yetenekler

Doğrudan değişim

Fonksiyon çağrısı

Yerleşik web araması

Yapılandırılmış çıktılar

Çok turlu araçlar

Akış

Hızlı başlangıç

Base URL’nizi ayarlayın

API anahtarınızı ekleyin

İlk mesajınızı gönderin

Yanıt formatı

API Oyun Alanı

Chat, Responses, Messages

Stream live output

Reuse your key

Kimlik Doğrulama

OpenAI Format (Recommended)

Anthropic Biçimi

Modeller

Fonksiyon Çağırma

Araç seçimi seçenekleri

Fonksiyon çağrısı yanıtı

Yapılandırılmış Çıktılar

Yanıt biçimi seçenekleri

Akış

Yerleşik Web Arama

Anthropic Biçimi

SDK'lar

OpenAI-Compatible SDKs

Anthropic-Compatible SDKs

Hata yönetimi

Hata yanıtı formatı

Değişiklik Günlüğü

API Anahtarınız

Kullanımınız

Shannon Coder (shannon-coder-1)

Oluşturmaya hazır mısınız?

Shannon AI API Documentation

Genel Bakış

Yetenekler

Doğrudan değişim

Fonksiyon çağrısı

Yerleşik web araması

Yapılandırılmış çıktılar

Çok turlu araçlar

Akış

Hızlı başlangıç

Base URL’nizi ayarlayın

API anahtarınızı ekleyin

İlk mesajınızı gönderin

Yanıt formatı

API Oyun Alanı

Chat, Responses, Messages

Stream live output

Reuse your key

Kimlik Doğrulama

OpenAI Format (Recommended)

Anthropic Biçimi

Modeller

Fonksiyon Çağırma

Araç seçimi seçenekleri

Fonksiyon çağrısı yanıtı

Yapılandırılmış Çıktılar

Yanıt biçimi seçenekleri

Akış

Yerleşik Web Arama

Anthropic Biçimi

SDK'lar

OpenAI-Compatible SDKs

Anthropic-Compatible SDKs

Hata yönetimi

Hata yanıtı formatı

Değişiklik Günlüğü

API Anahtarınız

Kullanımınız

Shannon Coder (shannon-coder-1)

Oluşturmaya hazır mısınız?