Dokumentacija API-ja Shannon AI

Pregled

Javna dokumentacija

Vse, kar potrebujete za izdajo z Shannonovim OpenAI- in Anthropic-združljivim API-jem.

Osnovni URL Združljivo z OpenAI

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

Uporabite API Chat Completions s klicanjem funkcij in pretakanjem.

Osnovni URL Združljivo z Anthropic

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

Format Claude Messages z orodji in glavo anthropic-version.

Glave Avtentikacija

Authorization: Bearer <api-key>

Ali X-API-Key z anthropic-version za klice v slogu Claude.

Dostop Stanje

Javna dokumentacija – ključ potreben za klic

Pretakanje, klicanje funkcij, strukturirani izhodi, spletno iskanje.

Kontrolni seznam za zagon

+

Usmerite svoj SDK na Shannon

Nastavite baseURL na zgornje OpenAI ali Anthropic končne točke.

Nastavitev
+

Dodajte svoj API ključ

Uporabite Bearer žetone za OpenAI klice ali X-API-Key + anthropic-version.

Varnost
+

Omogočite orodja in strukturirane izhode

Podpira OpenAI orodja/funkcije, JSON shemo in vgrajen web_search.

Zmožnosti
+

Spremljajte porabo

Oglejte si porabo žetonov in iskanja na tej strani, ko ste prijavljeni v račun.

Analitika

Zmožnosti

OpenAI + Anthropic

Neposredna zamenjava za OpenAI in Anthropic API-je z nativno podporo za orodja, strukturirane izhode in vgrajeno spletno iskanje.

Neposredna zamenjava

Združljivo

Deluje z OpenAI in Anthropic SDK-ji. Samo spremenite osnovni URL.

Klicanje funkcij

Orodja

Določite orodja, naj jih Shannon kliče. Podpira načine auto, forced in none.

Vgrajeno spletno iskanje

Iskanje

Spletno iskanje v realnem času z navedbami virov. Samodejno na voljo.

Strukturirani izhodi

JSON

JSON način in uveljavljanje JSON sheme za zanesljivo izločanje podatkov.

Več-obratna orodja

Agentsko

Samodejne zanke izvajanja funkcij. Do 10 iteracij na zahtevo.

Pretakanje

Hitro

Server-sent events za pretakanje žetonov v realnem času.

Hiter začetek

5 minut

Začnite v treh korakih. Shannon posnema odjemalce OpenAI in Anthropic.

Nastavite osnovni URL

Uporabite OpenAI-združljivo končno točko.

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

Dodajte svoj API ključ

Uporabite Bearer avtentikacijo v glavi Authorization.

Pošljite prvo sporočilo

Izberite jezik in zamenjajte svoj ključ.

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

Oblika odgovora

Uspešen odgovor

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

Novo

Preizkusite Shannon API neposredno v brskalniku. Sestavite zahtevo, jo zaženite in v realnem času poglejte odgovor.

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.

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

Preizkusi Playground V2 Pridobi svoj API ključ

Avtentikacija

Vse API zahteve zahtevajo avtentikacijo z vašim Shannon API ključem.

Format OpenAI (priporočeno)

HTTP

Authorization: Bearer YOUR_API_KEY

Format Anthropic

HTTP

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

Modeli

Shannon ponuja več modelov, optimiziranih za različne primere uporabe.

shannon-1.6-lite Shannon 1.6 Lite

Hitri, učinkoviti odgovori za vsakodnevne naloge

Kontekst 128K

Najboljše za Klepet, Vprašanja in odgovori, Generiranje vsebine

shannon-1.6-pro Shannon 1.6 Pro

Napredno razmišljanje za kompleksne probleme

Kontekst 128K

Najboljše za Analiza, Raziskave, Kompleksne naloge

shannon-2-lite Shannon 2 Lite

Kontekst 128K

Najboljše za

shannon-2-pro Shannon 2 Pro

Kontekst 128K

Najboljše za

shannon-coder-1 Shannon Coder

Optimizirano za Claude Code CLI s kvoto na klic

Kontekst 128K

Najboljše za Generiranje kode, uporaba orodij, integracija CLI

Kvota na klic

Klicanje funkcij

Določite orodja, ki jih Shannon lahko kliče za izvedbo dejanj ali pridobivanje informacij.

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

"auto" Model se odloči, ali bo poklical funkcijo (privzeto)

"none" Onemogoči klicanje funkcij za to zahtevo

{"type": "function", "function": {"name": "..."}} Vsili določen klic funkcije

Odgovor klica funkcije

Ko model pokliče funkcijo

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

Strukturirani izhodi

Prisili Shannona, da odgovori z veljavnim JSON-om, ki ustreza vaši shemi.

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

{"type": "json_object"} Prisili veljaven JSON izhod (brez posebne sheme)

{"type": "json_schema", "json_schema": {...}} Prisili izhod, ki ustreza vaši točni shemi

Pretakanje

Omogočite pretakanje žetonov v realnem času s Server-Sent Events za odzivne vmesnike.

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

Namig: Pretakani odgovori prispejo kot Server-Sent Events. Vsak kos vsebuje delni delta vsebine.

Vgrajeno spletno iskanje

Shannon vključuje vgrajeno funkcijo web_search, ki je samodejno na voljo.

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: Rezultati spletnega iskanja vsebujejo navedbe. Shannon bo samodejno navajal vire.

Format Anthropic

Shannon podpira tudi format 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);

Zahtevana glava: Format Anthropic zahteva anthropic-version: 2023-06-01.

SDK-ji

Združljivo

Uporabite kateri koli SDK OpenAI ali Anthropic – samo spremenite osnovni URL.

OpenAI-združljivi SDK-ji

SDK Python

Uradni OpenAI Python SDK – deluje s Shannon

pip install openai

Poglej dokumente ->

SDK JavaScript / TypeScript

Uradni OpenAI Node.js SDK – deluje s Shannon

npm install openai

Poglej dokumente ->

SDK Go

Skupnostni Go odjemalec za OpenAI-združljive API-je

go get github.com/sashabaranov/go-openai

Poglej dokumente ->

SDK Ruby

Skupnostni Ruby odjemalec za OpenAI-združljive API-je

gem install ruby-openai

Poglej dokumente ->

SDK PHP

Skupnostni PHP odjemalec za OpenAI-združljive API-je

composer require openai-php/client

Poglej dokumente ->

SDK Rust

Asinhroni Rust odjemalec za OpenAI-združljive API-je

cargo add async-openai

Poglej dokumente ->

Anthropic-združljivi SDK-ji

SDK Python (Anthropic)

Uradni Anthropic Python SDK – deluje s Shannon

pip install anthropic

Poglej dokumente ->

SDK TypeScript (Anthropic)

Uradni Anthropic TypeScript SDK – deluje s Shannon

npm install @anthropic-ai/sdk

Poglej dokumente ->

Obravnava napak

Shannon uporablja standardne HTTP statusne kode in vrača podrobna sporočila o napakah.

400 Neveljavna zahteva Neveljaven format zahteve ali parametri

401 Neavtorizirano Neveljaven ali manjkajoč API ključ

402 Kvota presežena Kvota žetonov ali iskanja presežena

429 Omejitev hitrosti Preveč zahtev, upočasnite

500 Napaka strežnika Notranja napaka, poskusite pozneje

Oblika odgovora napake

Odgovor napake

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

Dnevnik sprememb

LOG

Nedavne posodobitve in izboljšave Shannon API-ja.

v2.1.0

2025-01-03

Novo Dodan model shannon-coder-1 za integracijo Claude Code CLI
Novo Sistem kvot na klic za model Coder
Izboljšano Izboljšana zanesljivost klicanja funkcij

v2.0.0

2024-12-15

Novo Dodana združljivost z Anthropic Messages API
Novo Več-obratno izvajanje orodij (do 10 iteracij)
Novo Podpora za obliko odgovora JSON Schema
Izboljšano Izboljšano spletno iskanje z boljšimi navedbami

v1.5.0

2024-11-20

Novo Dodan model shannon-deep-dapo za kompleksno razmišljanje
Novo Vgrajena funkcija web_search
Izboljšano Zmanjšana zakasnitev za pretočne odgovore

v1.0.0

2024-10-01

Novo Začetna izdaja API
Novo OpenAI-združljiva končna točka chat completions
Novo Podpora za klicanje funkcij
Novo Pretakanje prek Server-Sent Events

Vaš API ključ

Dostop

Uporabite Bearer žetone za OpenAI klice ali X-API-Key + anthropic-version.

YOUR_API_KEY

Pridobi svoj API ključ

Vaš API ključ naj bo skrivnost. Ponovna izdaja ustvari nov ključ in razveljavi starega.

Vaša poraba

Oglejte si porabo žetonov in iskanja na tej strani, ko ste prijavljeni v račun.

-- API klici

-- Uporabljeni žetoni

Shannon API

Pregled

Zmožnosti

Neposredna zamenjava

Klicanje funkcij

Vgrajeno spletno iskanje

Strukturirani izhodi

Več-obratna orodja

Pretakanje

Hiter začetek

Nastavite osnovni URL

Dodajte svoj API ključ

Pošljite prvo sporočilo

Oblika odgovora

API Playground

Chat, Responses, Messages

Stream live output

Reuse your key

Avtentikacija

Format OpenAI (priporočeno)

Format Anthropic

Modeli

Klicanje funkcij

Možnosti izbire orodja

Odgovor klica funkcije

Strukturirani izhodi

Možnosti oblike odgovora

Pretakanje

Vgrajeno spletno iskanje

Format Anthropic

SDK-ji

OpenAI-združljivi SDK-ji

Anthropic-združljivi SDK-ji

Obravnava napak

Oblika odgovora napake

Dnevnik sprememb

Vaš API ključ

Vaša poraba

Shannon Coder (shannon-coder-1)

Pripravljeni za gradnjo?

Shannon AI API Documentation

Pregled

Zmožnosti

Neposredna zamenjava

Klicanje funkcij

Vgrajeno spletno iskanje

Strukturirani izhodi

Več-obratna orodja

Pretakanje

Hiter začetek

Nastavite osnovni URL

Dodajte svoj API ključ

Pošljite prvo sporočilo

Oblika odgovora

API Playground

Chat, Responses, Messages

Stream live output

Reuse your key

Avtentikacija

Format OpenAI (priporočeno)

Format Anthropic

Modeli

Klicanje funkcij

Možnosti izbire orodja

Odgovor klica funkcije

Strukturirani izhodi

Možnosti oblike odgovora

Pretakanje

Vgrajeno spletno iskanje

Format Anthropic

SDK-ji

OpenAI-združljivi SDK-ji

Anthropic-združljivi SDK-ji

Obravnava napak

Oblika odgovora napake

Dnevnik sprememb

Vaš API ključ

Vaša poraba

Shannon Coder (shannon-coder-1)

Pripravljeni za gradnjo?