Dokumentácia Shannon AI API

Prehľad

Verejné dokumenty

Všetko, čo potrebujete na spustenie s OpenAI/Anthropic kompatibilným API Shannon.

Základné URL Kompatibilné s OpenAI

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

Použite Chat Completions API s volaním funkcií a streamovaním.

Základné URL Kompatibilné s Anthropic

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

Formát Claude Messages s nástrojmi a hlavičkou anthropic-version.

Hlavičky Autentifikácia

Autorizácia: Bearer <vas-kluc>

Alebo X-API-Key s anthropic-version pre volania v štýle Claude.

Prístup Stav

Verejné dokumenty – na volanie je potrebný kľúč

Streamovanie, volanie funkcií, štruktúrované výstupy, webové vyhľadávanie.

Kontrolný zoznam spustenia

+

Nasmerujte svoj SDK na Shannon

Nastavte baseURL na OpenAI alebo Anthropic endpointy vyššie.

Nastavenie
+

Pripojte svoj API kľúč

Použite Bearer tokeny pre volania OpenAI alebo X-API-Key + anthropic-version.

Bezpečnosť
+

Povoľte nástroje a štruktúrované výstupy

Podporuje OpenAI nástroje/funkcie, JSON schému a vstavaný web_search.

Schopnosti
+

Sledujte používanie

Zobrazte spotrebu tokenov a vyhľadávania na tejto stránke, keď ste prihlásení.

Analytika

Možnosti

OpenAI + Anthropic

Drop-in náhrada za OpenAI a Anthropic API s natívnou podporou nástrojov, štruktúrovaných výstupov a vstavaného webového vyhľadávania.

Drop-in náhrada

Kompatibilné

Funguje s OpenAI a Anthropic SDK. Stačí zmeniť base URL.

Volanie funkcií

Nástroje

Definujte nástroje, Shannon ich zavolá. Podporuje auto, forced a none režimy.

Vstavané webové vyhľadávanie

Vyhľadávanie

Webové vyhľadávanie v reálnom čase s citáciami zdrojov. Automaticky dostupné.

Štruktúrované výstupy

JSON

Režim JSON a vynútenie JSON Schémy pre spoľahlivú extrakciu dát.

Nástroje pre viac ťahov

Agentné

Automatické slučky vykonávania funkcií. Až 10 iterácií na požiadavku.

Streamovanie

Rýchle

Server-sent events pre streamovanie tokenov v reálnom čase.

Rýchly štart

5 minút

Začnite v troch krokoch. Shannon zrkadlí klientov OpenAI a Anthropic.

Nastavte base URL

Použite endpoint kompatibilný s OpenAI.

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

Pridajte svoj API kľúč

Použite Bearer autentifikáciu v hlavičke Authorization.

Odošlite prvú správu

Vyberte jazyk a vložte svoj kľúč.

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

Formát odpovede

Úspešná odpoveď

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

Nové

Otestujte Shannon API priamo v prehliadači. Zostavte požiadavku, spustite ju a sledujte odpoveď v reálnom čase.

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.

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

Vyskúšať Playground V2 Získať API kľúč

Overenie

Všetky API požiadavky vyžadujú autentifikáciu pomocou vášho Shannon API kľúča.

OpenAI formát (odporúčané)

HTTP

Authorization: Bearer YOUR_API_KEY

Anthropic formát

HTTP

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

Modely

Shannon ponúka viacero modelov optimalizovaných pre rôzne prípady použitia.

shannon-1.6-lite Shannon 1.6 Lite

Rýchle, efektívne odpovede pre každodenné úlohy

Kontext 128K

Najlepšie pre Chat, Q&A, Generovanie obsahu

shannon-1.6-pro Shannon 1.6 Pro

Pokročilé uvažovanie pre komplexné problémy

Kontext 128K

Najlepšie pre Analýza, Výskum, Komplexné úlohy

shannon-2-lite Shannon 2 Lite

Kontext 128K

Najlepšie pre

shannon-2-pro Shannon 2 Pro

Kontext 128K

Najlepšie pre

shannon-coder-1 Shannon Coder

Optimalizované pre Claude Code CLI s kvótou podľa volaní

Kontext 128K

Najlepšie pre Generovanie kódu, Použitie nástrojov, Integrácia CLI

Kvóta podľa volaní

Volanie funkcií

Definujte nástroje, ktoré Shannon môže volať na vykonanie akcií alebo získanie informácií.

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

Možnosti výberu nástrojov

"auto" Model rozhodne, či zavolá funkciu (predvolené)

"none" Zakázať volanie funkcií pre túto požiadavku

{"type": "function", "function": {"name": "..."}} Vynútiť volanie konkrétnej funkcie

Odpoveď volania funkcie

Keď model zavolá funkciu

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

Štruktúrované výstupy

Vynútiť, aby Shannon odpovedal platným JSON, ktorý zodpovedá vašej schéme.

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

Možnosti formátu odpovede

{"type": "json_object"} Vynútiť platný JSON výstup (bez špecifickej schémy)

{"type": "json_schema", "json_schema": {...}} Vynútiť výstup zodpovedajúci vašej presnej schéme

Streamovanie

Povoľte streamovanie tokenov v reálnom čase pomocou Server-Sent Events pre responzívne UI.

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: Streamované odpovede prichádzajú ako Server-Sent Events. Každý chunk obsahuje delta s čiastočným obsahom.

Vstavané webové vyhľadávanie

Shannon obsahuje vstavanú funkciu web_search, ktorá je automaticky dostupná.

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 tip: Výsledky webového vyhľadávania obsahujú citácie. Shannon automaticky cituje zdroje.

Formát Anthropic

Shannon tiež podporuje formát 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);

Povinná hlavička: Anthropic formát vyžaduje anthropic-version: 2023-06-01.

SDK

Kompatibilné

Použite akýkoľvek OpenAI alebo Anthropic SDK – stačí zmeniť base URL.

OpenAI kompatibilné SDK

SDK Python

Oficiálny OpenAI Python SDK - funguje so Shannon

pip install openai

Zobraziť dokumentáciu ->

SDK JavaScript / TypeScript

Oficiálny OpenAI Node.js SDK - funguje so Shannon

npm install openai

Zobraziť dokumentáciu ->

SDK Go

Komunitný Go klient pre OpenAI kompatibilné API

go get github.com/sashabaranov/go-openai

Zobraziť dokumentáciu ->

SDK Ruby

Komunitný Ruby klient pre OpenAI kompatibilné API

gem install ruby-openai

Zobraziť dokumentáciu ->

SDK PHP

Komunitný PHP klient pre OpenAI kompatibilné API

composer require openai-php/client

Zobraziť dokumentáciu ->

SDK Rust

Asynchrónny Rust klient pre OpenAI kompatibilné API

cargo add async-openai

Zobraziť dokumentáciu ->

Anthropic kompatibilné SDK

SDK Python (Anthropic)

Oficiálny Anthropic Python SDK - funguje so Shannon

pip install anthropic

Zobraziť dokumentáciu ->

SDK TypeScript (Anthropic)

Oficiálny Anthropic TypeScript SDK - funguje so Shannon

npm install @anthropic-ai/sdk

Zobraziť dokumentáciu ->

Spracovanie chýb

Shannon používa štandardné HTTP status kódy a vracia podrobné chybové správy.

400 Neplatná požiadavka Neplatný formát požiadavky alebo parametre

401 Neautorizované Neplatný alebo chýbajúci API kľúč

402 Kvóta prekročená Prekročená kvóta tokenov alebo vyhľadávania

429 Obmedzenie rýchlosti Príliš veľa požiadaviek, spomaľte

500 Chyba servera Interná chyba, skúste neskôr

Formát chybovej odpovede

Chybová odpoveď

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

Zoznam zmien

LOG

Nedávne aktualizácie a zlepšenia Shannon API.

v2.1.0

2025-01-03

Nové Pridaný model shannon-coder-1 pre integráciu s Claude Code CLI
Nové Systém kvót podľa volaní pre model Coder
Zlepšené Zlepšená spoľahlivosť volania funkcií

v2.0.0

2024-12-15

Nové Pridaná kompatibilita s Anthropic Messages API
Nové Viac‑ťahové vykonanie nástrojov (až 10 iterácií)
Nové Podpora formátu odpovede JSON Schema
Zlepšené Vylepšené webové vyhľadávanie s lepšími citáciami

v1.5.0

2024-11-20

Nové Pridaný model shannon-deep-dapo pre komplexné uvažovanie
Nové Vstavaná funkcia web_search
Zlepšené Znížená latencia pre streamované odpovede

v1.0.0

2024-10-01

Nové Prvé vydanie API
Nové OpenAI kompatibilný chat completions endpoint
Nové Podpora volania funkcií
Nové Streamovanie cez Server-Sent Events

Váš API kľúč

Prístup

Použite Bearer tokeny pre volania OpenAI alebo X-API-Key + anthropic-version.

YOUR_API_KEY

Získať API kľúč

Uchovajte svoj API kľúč v tajnosti. Regenerovanie vytvorí nový kľúč a zneplatní starý.

Vaše využitie

Zobrazte spotrebu tokenov a vyhľadávania na tejto stránke, keď ste prihlásení.

-- API volania

-- Použité tokeny

Shannon API

Prehľad

Možnosti

Drop-in náhrada

Volanie funkcií

Vstavané webové vyhľadávanie

Štruktúrované výstupy

Nástroje pre viac ťahov

Streamovanie

Rýchly štart

Nastavte base URL

Pridajte svoj API kľúč

Odošlite prvú správu

Formát odpovede

Playground

Chat, Responses, Messages

Stream live output

Reuse your key

Overenie

OpenAI formát (odporúčané)

Anthropic formát

Modely

Volanie funkcií

Možnosti výberu nástrojov

Odpoveď volania funkcie

Štruktúrované výstupy

Možnosti formátu odpovede

Streamovanie

Vstavané webové vyhľadávanie

Formát Anthropic

SDK

OpenAI kompatibilné SDK

Anthropic kompatibilné SDK

Spracovanie chýb

Formát chybovej odpovede

Zoznam zmien

Váš API kľúč

Vaše využitie

Shannon Coder (shannon-coder-1)

Ste pripravení stavať?

Shannon AI API Documentation

Prehľad

Možnosti

Drop-in náhrada

Volanie funkcií

Vstavané webové vyhľadávanie

Štruktúrované výstupy

Nástroje pre viac ťahov

Streamovanie

Rýchly štart

Nastavte base URL

Pridajte svoj API kľúč

Odošlite prvú správu

Formát odpovede

Playground

Chat, Responses, Messages

Stream live output

Reuse your key

Overenie

OpenAI formát (odporúčané)

Anthropic formát

Modely

Volanie funkcií

Možnosti výberu nástrojov

Odpoveď volania funkcie

Štruktúrované výstupy

Možnosti formátu odpovede

Streamovanie

Vstavané webové vyhľadávanie

Formát Anthropic

SDK

OpenAI kompatibilné SDK

Anthropic kompatibilné SDK

Spracovanie chýb

Formát chybovej odpovede

Zoznam zmien

Váš API kľúč

Vaše využitie

Shannon Coder (shannon-coder-1)

Ste pripravení stavať?