Shannon AI API Sənədləri

Ümumi baxış

Public docs

Shannon-un OpenAI və Anthropic uyğun API-si ilə məhsul göndərmək üçün lazım olan hər şey.

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 Doğrulama

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.

İmkanlar
+

Track usage

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

Analytics

İmkanlar

OpenAI + Anthropic

OpenAI və Anthropic API-ləri üçün birbaşa əvəz — alətlər, strukturlaşdırılmış çıxışlar və daxili veb axtarış dəstəyi ilə.

Drop‑in əvəzləmə

Uyğun

OpenAI və Anthropic SDK‑ları ilə işləyir. Sadəcə baza URL‑ni dəyişin.

Funksiya çağırışı

Alətlər

Alətləri müəyyən edin, Shannon onları çağırsın. auto, forced və none rejimlərini dəstəkləyir.

Daxili veb axtarış

Axtarış

Mənbə istinadları ilə real‑time veb axtarış. Avtomatik mövcuddur.

Strukturlaşdırılmış çıxışlar

JSON

Etibarlı məlumat çıxarışı üçün JSON rejimi və JSON Schema tətbiqi.

Çox mərhələli alətlər

Agentik

Avtomatik funksiya icrası dövrləri. Hər sorğu üçün 10 iterasiyaya qədər.

Axın

Sürətli

Real‑time token axını üçün server‑sent events.

Sürətli başlanğıc

5 dəqiqə

Üç addımda başlayın. Shannon OpenAI və Anthropic müştərilərini əks etdirir.

Baza URL‑ni təyin edin

OpenAI‑uyğun endpoint istifadə edin.

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

API açarınızı əlavə edin

Authorization başlığında Bearer auth istifadə edin.

İlk mesajınızı göndərin

Dil seçin və açarınızı daxil edin.

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

Cavab formatı

Uğurlu cavab

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

Yeni

Shannon API‑ni brauzerdə birbaşa sınaqdan keçirin. Sorğu yaradın, işlədin və cavabı real‑time 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.

/az/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 yoxla V2 API açarını əldə et

Doğrulama

Bütün API sorğuları Shannon API açarı ilə doğrulama tələb edir.

OpenAI Format (Recommended)

HTTP

Authorization: Bearer YOUR_API_KEY

Anthropic

HTTP

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

Modellər

Shannon müxtəlif istifadə hallarına uyğun optimallaşdırılmış bir neçə model təklif edir.

shannon-1.6-lite Shannon 1.6 Lite

Fast, efficient responses for everyday tasks

Kontekst 128K

Təhlükəsizlik Mütəxəssisləri Üçün Qurulub Chat, Q&A, Content Generation

shannon-1.6-pro Shannon 1.6 Pro

Advanced reasoning for complex problems

Kontekst 128K

Təhlükəsizlik Mütəxəssisləri Üçün Qurulub Analysis, Research, Complex Tasks

shannon-2-lite Shannon 2 Lite

Kontekst 128K

Təhlükəsizlik Mütəxəssisləri Üçün Qurulub

shannon-2-pro Shannon 2 Pro

Kontekst 128K

Təhlükəsizlik Mütəxəssisləri Üçün Qurulub

shannon-coder-1 Shannon Coder

Optimized for Claude Code CLI with call-based quota

Kontekst 128K

Təhlükəsizlik Mütəxəssisləri Üçün Qurulub Code Generation, Tool Use, CLI Integration

Call-based quota

Funksiya çağırışı

Shannon-un hərəkət yerinə yetirməsi və ya məlumat əldə etməsi üçün çağıra biləcəyi alətləri müəyyən edin.

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

Funksiya çağı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

Cavab formatı

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

Strukturlaşdırılmış çıxışlar

Shannon-un sxeminizə uyğun etibarlı JSON ilə cavab verməsini məcbur edin.

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

Cavab formatı

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

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

Axın

Responsiv UI üçün Server‑Sent Events ilə real vaxt token axınını aktivləşdirin.

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.

Veb axtarışı

Shannon avtomatik əlçatan olan daxili web_search funksiyasını ehtiva edir.

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

Məsləhət: Web search results include citations. Shannon will automatically cite sources.

Anthropic

Shannon həm də Anthropic Messages API formatını dəstəkləyir.

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.

SDK-lar

Uyğun

İstənilən OpenAI və ya Anthropic SDK istifadə edin — sadəcə baza URL-ni dəyişin.

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

Xəta idarəetməsi

Shannon standart HTTP status kodlarından istifadə edir və detallı xəta mesajları qaytarır.

400 Səhv sorğu Yanlış sorğu formatı və ya parametrlər

401 Səlahiyyətsiz Yanlış və ya çatışmayan API açarı

402 Kvota aşıldı Token və ya axtarış kvotası aşıldı

429 Sürət məhdud Çoxlu sorğu, yavaşlayın

500 Server xətası Daxili xəta, sonra yenidən cəhd edin

Xəta cavab formatı

Xəta cavabı

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

Dəyişikliklər jurnalı

LOG

Shannon API üçün son yeniliklər və təkmilləşdirmələr.

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

Sizin API açarınız

Access

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

YOUR_API_KEY

API açarını əldə et

API açarınızı gizli saxlayın. Yenidən yaratmaq yeni açar yaradır və köhnəni etibarsız edir.

İstifadəniz

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

-- API çağırışları

-- İstifadə olunan tokenlər

Shannon API

Ümumi baxış

İmkanlar

Drop‑in əvəzləmə

Funksiya çağırışı

Daxili veb axtarış

Strukturlaşdırılmış çıxışlar

Çox mərhələli alətlər

Axın

Sürətli başlanğıc

Baza URL‑ni təyin edin

API açarınızı əlavə edin

İlk mesajınızı göndərin

Cavab formatı

API oyun meydanı

Chat, Responses, Messages

Stream live output

Reuse your key

Doğrulama

OpenAI Format (Recommended)

Anthropic

Modellər

Funksiya çağırışı

Funksiya çağırışı

Cavab formatı

Strukturlaşdırılmış çıxışlar

Cavab formatı

Axın

Veb axtarışı

Anthropic

SDK-lar

OpenAI-Compatible SDKs

Anthropic-Compatible SDKs

Xəta idarəetməsi

Xəta cavab formatı

Dəyişikliklər jurnalı

Sizin API açarınız

İstifadəniz

Shannon Coder (shannon-coder-1)

Qurmağa hazırsan?

Shannon AI API Documentation

Ümumi baxış

İmkanlar

Drop‑in əvəzləmə

Funksiya çağırışı

Daxili veb axtarış

Strukturlaşdırılmış çıxışlar

Çox mərhələli alətlər

Axın

Sürətli başlanğıc

Baza URL‑ni təyin edin

API açarınızı əlavə edin

İlk mesajınızı göndərin

Cavab formatı

API oyun meydanı

Chat, Responses, Messages

Stream live output

Reuse your key

Doğrulama

OpenAI Format (Recommended)

Anthropic

Modellər

Funksiya çağırışı

Funksiya çağırışı

Cavab formatı

Strukturlaşdırılmış çıxışlar

Cavab formatı

Axın

Veb axtarışı

Anthropic

SDK-lar

OpenAI-Compatible SDKs

Anthropic-Compatible SDKs

Xəta idarəetməsi

Xəta cavab formatı

Dəyişikliklər jurnalı

Sizin API açarınız

İstifadəniz

Shannon Coder (shannon-coder-1)

Qurmağa hazırsan?