Belgekirina Shannon AI API

Têkilî

Docsên giştî

Hemû tiştên ku pêdivî ye ji bo hilweşandinê bi APIya Shannon a ku bi OpenAI û Anthropic re hevaheng e.

URL OpenAI‑hevaheng

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

Chat Completions API bi bangkirina fonksiyon û streaming bikar bîne.

URL Anthropic‑hevaheng

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

Formata Claude Messages bi amûr û headerê anthropic-version.

Header Nasname

Authorization: Bearer <api-key>

Yan jî X-API-Key bi anthropic-version ji bo bangên şêwazê Claude.

Gihîştin Rewş

Docsên giştî - ji bo bang kirinê pêdivî bi kilîd e

Streaming, bangkirina fonksiyon, derketinên strukturkirî, lêgerîna webê.

Rêza kontrola destpêkê

+

SDK‑a xwe ber bi Shannon re bîne

baseURL ê li ser endpoints‑ên OpenAI an Anthropic yên jor biavêje.

Sazdan
+

Kilîda API‑a xwe biqedîne

Ji bo bangên OpenAI Bearer tokenan an X-API-Key + anthropic-version bikar bîne.

Ewlehî
+

Amûr û structured outputs çalak bike

OpenAI tools/functions, JSON schema û built-in web_search piştgirî dike.

Şopandin
+

Bikaranînê bişopîne

Dema ku têketî yî, li vê rûpelê xercê token û lêgerînê bibîne.

Analîtîk

Pêşandanan

OpenAI + Anthropic

Cihgirtina drop‑in ji bo APIyên OpenAI û Anthropic, bi piştgiriya amûran, derketinên strukturkirî û lêgerîna webê ya avakirî.

Drop‑in Replacement

Hevaheng

Bi SDK‑ên OpenAI û Anthropic re dixebite. Tenê base URL biguherîne.

Bangkirina fonksiyon

Amûr

Amûran define bike, Shannon wan dibangîne. Modi auto, forced, none piştgirî dike.

Lêgerîna webê ya built‑in

Lêgerîn

Lêgerîna webê bi demê rast bi jêderan. Otomatîk heye.

Derketinên strukturkirî

JSON

Moda JSON û JSON Schema enforcement ji bo derxistina daneyan.

Amûrên multi‑turn

Agentîk

Loopên otomatîk ên xebitandina fonksiyonan. Heta 10 iterasyonan.

Streaming

Lez

Server‑Sent Events ji bo streaming‑a tokenan bi demê rast.

Destpêka zû

5 deqe

Di sê gavên de dest pê bikin. Shannon mîna klîentên OpenAI û Anthropic dike.

base URL‑a xwe saz bike

Endpointa hevaheng ya OpenAI bikar bîne.

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

Kilîda API‑a xwe zêde bike

Di headerê Authorization de Bearer auth bikar bîne.

Peyama xwe ya yekem bişîne

Ziman hilbijêre û kilîda xwe biguherîne.

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

Formata bersivê

Bersiva serkeftî

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

Nû

Shannon API rasterast di nav geroka xwe de test bike. Daxwazê çêbike, bixebitîne û bersivê bi demê rast bibîne.

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.

/ku/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ê biceribîne V2 Kilîta API-ya xwe bistîne

Rastandin

Hemû daxwazên API bi kilîta Shannon API pêdivî ye were rastandin.

Formata OpenAI (pêşniyarkirî)

HTTP

Authorization: Bearer YOUR_API_KEY

Formata Anthropic

HTTP

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

Model

Shannon gelek modelên ku ji bo cihên bikaranînê cuda hatine optimize kirin pêşkêş dike.

shannon-1.6-lite Shannon 1.6 Lite

Bersivên bilez û bandorker ji bo karên rojane

Kontekst 128K

Herî baş ji bo Chat, Q&A, Çêkirina naverokê

shannon-1.6-pro Shannon 1.6 Pro

Rizvanîya pêşkeftî ji bo pirsgirêkên tevlihev

Kontekst 128K

Herî baş ji bo Analîz, Lêkolîn, Karên tevlihev

shannon-2-lite Shannon 2 Lite

Kontekst 128K

Herî baş ji bo

shannon-2-pro Shannon 2 Pro

Kontekst 128K

Herî baş ji bo

shannon-coder-1 Shannon Coder

Ji bo Claude Code CLI bi quota‑ya li ser bangê hate xelat kirin

Kontekst 128K

Herî baş ji bo Çêkirina kodê, Bikarhêneriya amûran, Integrasyona CLI

Quota ya li ser bang

Bangkirina fonksiyonê

Amûrên ku Shannon dikare banga wan bike ji bo kirinê an jî wergirtina agahî diyar bikin.

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

Vebijarkên hilbijartina amûran

"auto" Model biryar dide ku fonksiyon bibe bangkirin an na (default)

"none" Ji bo vê daxwazê bangkirina fonksiyonan bigire

{"type": "function", "function": {"name": "..."}} Bangkirina fonksiyonekê taybet bipêşîne

Bersiva bangkirina fonksiyon

Gava model fonksiyon dibangîne

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

Derketinên strukturkirî

Shannon bi JSONê derbasdar re bersiv bide ku bi şemayê te re hevaheng e.

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

Vebijarkên formata bersivê

{"type": "json_object"} Derketina JSON ya derbasdar mecbûr bike (bê schema taybet)

{"type": "json_schema", "json_schema": {...}} Derketina ku bi schema‑ya te ya rastî re têkçûyî ye mecbûr bike

Streaming

Ji bo UI yên bersivdar, streaming‑a tokena dem‑rast bi Server‑Sent Events çalak bikin.

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

Tîp: Bersivên streaming wek Server‑Sent Events tên. Her parçeyek delta‑yek bi naveroka qismî tê de heye.

Lêgerîna webê

Shannon tê de web_search‑a hundirîn heye ku bi awayek otomatik peyda ye.

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 Tîp: Encamên lêgerîna webê jêderan dihewîne. Shannon bi awtomatîk jêderan cite dike.

Anthropic

Shannon formatê Anthropic Messages API jî piştgirî dike.

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ê pêwîst: Formata Anthropic pêdivî bi anthropic-version: 2023-06-01 heye.

SDK

Hevaheng

Her SDK‑a OpenAI an Anthropic bikar bînin — tenê base URL biguherînin.

SDK‑ên OpenAI‑hevaheng

SDK Python

SDK‑a fermî ya OpenAI Python - bi Shannon re dixebite

pip install openai

Docs bibîne ->

SDK JavaScript / TypeScript

SDK‑a fermî ya OpenAI Node.js - bi Shannon re dixebite

npm install openai

Docs bibîne ->

SDK Go

Klienta komînî ya Go ji bo API‑ên OpenAI‑hevaheng

go get github.com/sashabaranov/go-openai

Docs bibîne ->

SDK Ruby

Klienta komînî ya Ruby ji bo API‑ên OpenAI‑hevaheng

gem install ruby-openai

Docs bibîne ->

SDK PHP

Klienta komînî ya PHP ji bo API‑ên OpenAI‑hevaheng

composer require openai-php/client

Docs bibîne ->

SDK Rust

Klienta Async Rust ji bo API‑ên OpenAI‑hevaheng

cargo add async-openai

Docs bibîne ->

SDK‑ên Anthropic‑hevaheng

SDK Python (Anthropic)

SDK‑a fermî ya Anthropic Python - bi Shannon re dixebite

pip install anthropic

Docs bibîne ->

SDK TypeScript (Anthropic)

SDK‑a fermî ya Anthropic TypeScript - bi Shannon re dixebite

npm install @anthropic-ai/sdk

Docs bibîne ->

Çewtî

Shannon kodên standard ên rewşa HTTP bikar tîne û peyamên çewtiyê yên detaydar vedigere.

400 Daxwaza çewt Formata daxwazê an parametreyên çewt

401 Ne‑destûr Kilîda API ya çewt an winda

402 Quota derbas bû Quota ya token an lêgerîn derbas bû

429 Sînorê rêjeyê Pir daxwaz, herî hîn neke

500 Çewtiya serverê Çewtiya navxweyî, paşê dubare biceribîne

Formata bersiva çewtiyê

Bersiva çewtiyê

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

Loga guherandinan

LOG

Nûvekirin û baştirinên nêzîk li Shannon API.

v2.1.0

2025-01-03

Nû Modêla shannon-coder-1 ji bo Claude Code CLI integrasyon hate zêdekirin
Nû Sîstema quota ya li ser bang ji bo modêla Coder
Bihezkirî Ewlehiya bangkirina fonksiyonan hate başkirin

v2.0.0

2024-12-15

Nû Kompatîbilîtiya Anthropic Messages API hate zêdekirin
Nû Xebitandina amûrên multi‑turn (heta 10 iterasyonan)
Nû Piştgirî ya formata bersivê ya JSON Schema
Bihezkirî Lêgerîna webê bi jêderên baştir hate başkirin

v1.5.0

2024-11-20

Nû Modêla shannon-deep-dapo ji bo rizvanîya tevlihev hate zêdekirin
Nû Built‑in web_search
Bihezkirî Derengiya bersivên streaming kêm bû

v1.0.0

2024-10-01

Nû Weşana destpêkê ya API
Nû Endpointa chat completions ya OpenAI‑hevaheng
Nû Piştgirî ya bangkirina fonksiyon
Nû Streaming bi Server‑Sent Events

Kilîta API

Gihîştin

Ji bo bangên OpenAI Bearer tokenan an X-API-Key + anthropic-version bikar bîne.

YOUR_API_KEY

Kilîta API-ya xwe bistîne

Kilîda API‑a xwe nepênûsîne. Dîsa çêkirin kilîdek nû çêdike û kevn radesîne.

Bikaranîn

Dema ku têketî yî, li vê rûpelê xercê token û lêgerînê bibîne.

-- Bangên API

-- Tokenên bikaranîn

Shannon API

Têkilî

Pêşandanan

Drop‑in Replacement

Bangkirina fonksiyon

Lêgerîna webê ya built‑in

Derketinên strukturkirî

Amûrên multi‑turn

Streaming

Destpêka zû

base URL‑a xwe saz bike

Kilîda API‑a xwe zêde bike

Peyama xwe ya yekem bişîne

Formata bersivê

API Playground

Chat, Responses, Messages

Stream live output

Reuse your key

Rastandin

Formata OpenAI (pêşniyarkirî)

Formata Anthropic

Model

Bangkirina fonksiyonê

Vebijarkên hilbijartina amûran

Bersiva bangkirina fonksiyon

Derketinên strukturkirî

Vebijarkên formata bersivê

Streaming

Lêgerîna webê

Anthropic

SDK

SDK‑ên OpenAI‑hevaheng

SDK‑ên Anthropic‑hevaheng

Çewtî

Formata bersiva çewtiyê

Loga guherandinan

Kilîta API

Bikaranîn

Shannon Coder (shannon-coder-1)

Ji bo avakirinê amade ye?

Shannon AI API Documentation

Têkilî

Pêşandanan

Drop‑in Replacement

Bangkirina fonksiyon

Lêgerîna webê ya built‑in

Derketinên strukturkirî

Amûrên multi‑turn

Streaming

Destpêka zû

base URL‑a xwe saz bike

Kilîda API‑a xwe zêde bike

Peyama xwe ya yekem bişîne

Formata bersivê

API Playground

Chat, Responses, Messages

Stream live output

Reuse your key

Rastandin

Formata OpenAI (pêşniyarkirî)

Formata Anthropic

Model

Bangkirina fonksiyonê

Vebijarkên hilbijartina amûran

Bersiva bangkirina fonksiyon

Derketinên strukturkirî

Vebijarkên formata bersivê

Streaming

Lêgerîna webê

Anthropic

SDK

SDK‑ên OpenAI‑hevaheng

SDK‑ên Anthropic‑hevaheng

Çewtî

Formata bersiva çewtiyê

Loga guherandinan

Kilîta API

Bikaranîn

Shannon Coder (shannon-coder-1)

Ji bo avakirinê amade ye?