Shannon AI API Documentation

Dulmar

Docsyada dadweynaha

Wax kasta oo aad u baahan tahay si aad ugu soo rarto Shannon's OpenAI iyo API ku habboon Anthropic.

Saldhig URL FurAI-ku habboon

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

Adeegso Chat Completions API oo leh wacitaanka shaqada iyo qulqulka

Saldhig URL Anthropic-waafaqsan

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

Farriimaha Claude oo leh qalab iyo madax nooca nooca anthropic.

Madax Xaqiijinta

Oggolaanshaha: Qaade <furahaaga>

Ama X-API-Key oo wata nooca anthropic-ka ee wicitaanada qaabka Claude.

Helitaanka Xaalada

Dukumentiyada dadweynaha - Furaha ayaa loo baahan yahay in la waco

Socodka, wicitaanka shaqada, wax soo saarka habaysan, raadinta shabakadda.

Bilaw liiska hubinta

+

Tilmaan SDK-gaaga Shannon

U deji baseURL meelaha ugu dambeeya ee OpenAI ama Anthropic ee sare.

Dejinta
+

Ku dheji furahaaga API

U adeegso calaamado xanbaarsan wicitaanada OpenAI ama X-API-key + nooca anthropic.

Amniga
+

Daar qalabka & wax soo saarka habaysan

Waxay taageertaa aaladaha/howlaha OpenAI, schema JSON, iyo web_search ku dhex jira.

Awoodaha
+

La soco isticmaalka

Ka eeg calaamada iyo isticmaalka ka raadi boggan markaad gasho akoonkaaga

Falanqaynta

Awoodaha

FurAI + Anthropic

Beddelka ku-meel-gaadhka ah ee OpenAI iyo Anthropic API-yada oo leh taageerada hooyo ee agabka, wax soo saarka habaysan, iyo goob-raadinta shabakadda.

Beddelka Soo Gelida

La jaanqaadi karo

Waxay la shaqaysaa OpenAI iyo SDK-yada Anthropic. Kaliya beddel URL-ka aasaasiga ah.

Wacyigelinta Shaqada

Qalabka

Qeex qalabka, Shannon ha u yeedho. Waxay taageertaa auto, qasab, iyo midna habab.

Ku-dhismay Raadinta Shabakadda

Raadi

Raadinta mareegta-waqtiga dhabta ah oo leh xigashooyin ilo. Si toos ah ayaa loo heli karaa

Waxsoosaarka qaabaysan

JSON

Habka JSON iyo JSON Qorshaha fulinta ee soo saarista xogta la isku halayn karo.

Aalado kala-rogasho badan

Wakiil

Wareegyo fulin shaqo oo toos ah Ilaa 10 ku celcelin codsi kasta

Streaming

Degdeg ah

Dhacdooyinka loo soo diray Server-ka ee wakhtiga-dhabta ah ee tokenka

Bilaw degdeg ah

5 daqiiqo

Ku bilow saddex tallaabo. Shannon muraayadaha OpenAI iyo macaamiisha Anthropic.

Deji URL-kaaga saldhiga

Isticmaal barta dhamaadka ku habboon ee OpenAI.

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

Ku dar furahaaga API

Ku isticmaal warqadda aqoonsiga ee madaxa Oggolaanshaha.

Dir fariintaada ugu horeysa

Dooro luqad oo ku beddel furahaaga.

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

Qaabka jawaabta

Jawaabta Guusha

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

Goobta ciyaarta API

Cusub

Tijaabi Shannon API si toos ah browserkaaga. Dhis codsigaaga, socodsii, oo arag jawaabta wakhtiga dhabta ah.

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.

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

Isku day garoonka ciyaaraha V2 Hel Furahaaga API

Xaqiijinta

Dhammaan codsiyada API waxay u baahan yihiin xaqiijin iyadoo la isticmaalayo furahaaga Shannon API.

Qaabka Fur AI (lagu taliyay)

HTTP

Authorization: Bearer YOUR_API_KEY

Qaabka Anthropic

HTTP

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

Qaababka

Shannon waxay bixisaa noocyo badan oo loo habeeyay kiisaska isticmaalka kala duwan.

shannon-1.6-lite Shannon 1.6 Lite

Jawaabaha degdega ah, hufan ee hawlaha maalinlaha ah

Dulucda sheekada 128K

Ugu Wanaagsan Sheekaysi, Q&A, Jiilka nuxurka

shannon-1.6-pro Shannon 1.6 Pro

Sababta sare ee dhibaatooyinka adag

Dulucda sheekada 128K

Ugu Wanaagsan Falanqaynta, Cilmi-baarista, Hawlaha Kakan

shannon-2-lite Shannon 2 Lite

Dulucda sheekada 128K

Ugu Wanaagsan

shannon-2-pro Shannon 2 Pro

Dulucda sheekada 128K

Ugu Wanaagsan

shannon-coder-1 Shannon Coder

Lagu hagaajiyay Claude Code CLI oo leh qoondo ku salaysan wac

Dulucda sheekada 128K

Ugu Wanaagsan Jiilka Koodhka, Isticmaalka Qalabka, Is-dhexgalka CLI

Kootada ku salaysan wac

Wacyigelinta Shaqada

Qeex qalabka ay Shannon wici karto si ay u qabato ficilada ama u soo ceshato macluumaadka.

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

Xulashada Qalabka

"auto" Qaabka ayaa go'aamiya in la wacayo hawl (default)

"none" Dami shaqada wacitaanka codsigan

{"type": "function", "function": {"name": "..."}} Ku qasbi wicitaan hawleed gaar ah

Jawaabta Wacyigelinta Shaqada

Marka moodelku wacdo shaqo

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

Waxsoosaarka qaabaysan

Ku qas Shannon inay kaga jawaabto JSON sax ah oo ku habboon qorshahaaga.

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

Xulashada Qaabka Jawaabta

{"type": "json_object"} Xooga saara JSON sax ah (ma jiro qorshe gaar ah)

{"type": "json_schema", "json_schema": {...}} Ku qas wax soo saarka ee ku habboon qorshahaaga saxda ah

Streaming

Ku suurtageli baahinta summada-waqtiga-dhabta ah ee dhacdooyinka Server-la diray ee UI-yada ka jawaaba.

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

Talo: Jawaabaha socodka waxay u yimaadaan sidii Dhacdooyinka Server-La diray. Qayb kastaa waxay ka kooban tahay delta oo leh qayb qayb ah.

Ku-dhismay Raadinta Shabakadda

Shannon waxaa ku jira shaqo_raadinta shabakad ku dhex dhisan oo si toos ah loo heli karo.

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

Talada Pro: Natiijooyinka raadinta shabakadda waxaa ku jira xigasho. Shannon waxay si toos ah u soo xigan doontaa ilo.

Qaabka Anthropic

Shannon sidoo kale waxay taageertaa qaabka Farriimaha Anthropic ee 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);

Madaxa loo baahan yahay: Qaabka Anthropic wuxuu u baahan yahay nooca-anthropic: 2023-06-01.

SDKs

La jaanqaadi karo

Isticmaal SDK kasta oo furan AI ama Anthropic - kaliya beddel URL-ka saldhigga ah.

FurAI-SDK-ku-wanaagsan

SDK Python

OpenAI Python SDK ee rasmiga ah - waxay la shaqeysaa Shannon

pip install openai

Daawo Docs ->

SDK JavaScript / TypeScript

Rasmiga ah OpenAI Node.js SDK - wuxuu la shaqeeyaa Shannon

npm install openai

Daawo Docs ->

SDK Go

Community Go macmiilka APIs ku habboon OpenAI

go get github.com/sashabaranov/go-openai

Daawo Docs ->

SDK Ruby

Beesha Ruby macmiilka ee API-yada ku habboon OpenAI

gem install ruby-openai

Daawo Docs ->

SDK PHP

Macmiilka bulshada ee PHP ee API-yada ku habboon OpenAI

composer require openai-php/client

Daawo Docs ->

SDK Rust

Macmiilka Async Rust ee API-yada ku habboon OpenAI

cargo add async-openai

Daawo Docs ->

SDK-yada Anthropic-ku habboon

SDK Python (Anthropic)

Python SDK-ga rasmiga ah ee Anthropic - wuxuu la shaqeeyaa Shannon

pip install anthropic

Daawo Docs ->

SDK TypeScript (Anthropic)

Nooca rasmiga ah ee Anthropic TypeScript SDK - wuxuu la shaqeeyaa Shannon

npm install @anthropic-ai/sdk

Daawo Docs ->

Khaladaadka Maareynta

Shannon waxay isticmaashaa summada heerka HTTP waxayna soo celisaa farriimaha khaladka oo faahfaahsan.

400 Codsi Xun Qaab codsi ama cabbirro aan sax ahayn

401 Aan la fasaxin Furaha API aan sax ahayn ama maqan

402 Kootada ayaa dhaaftay Calaamada ama kootada raadinta waa dhaaftay

429 Qiimaha Limited Codsiyo badan, hoos u dhig

500 Cilad Server Cilad gudeed, isku day hadhow

Qaabka Jawaabta Khaladka

Jawaabta Khaladka

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

Changelog

LOG

Cusbooneysiinta iyo hagaajinta dhow ee Shannon API.

v2.1.0

2025-01-03

Cusub Lagu daray qaabka shannon-coder-1 ee isku dhafka Claude Code CLI
Cusub Nidaamka kootada ku salaysan wac ee nooca Coder
La hagaajiyay Isku halaynta wacitaanka shaqada oo la hagaajiyay

v2.0.0

2024-12-15

Cusub Ku darida fariimaha Anthropic API waafaqid
Cusub Fulinta aaladaha-rogadka badan (ilaa 10 ku celcelin)
Cusub Taageerada qaabka jawaabta Schema JSON
La hagaajiyay Raadinta shabakadda oo la xoojiyey oo leh tixraacyo ka wanaagsan

v1.5.0

2024-11-20

Cusub Qaabka shannon-qoto dheer-dapo ee lagu daray sababo adag
Cusub Shaqadda raadinta shabakada ee ku dhex jirta
La hagaajiyay Daahitaannada la dhimay ee jawaabaha qulqulka

v1.0.0

2024-10-01

Cusub Siideynta API-ga hore
Cusub Wada sheekaysiga ku habboon ee OpenAI wuxuu dhammaystiray barta dhamaadka
Cusub Taageerada wicitaanka shaqada
Cusub Ku qulqulaya iyada oo loo marayo Dhacdooyinka Server-ku soo diray

Furahaaga API

Helitaanka

U adeegso calaamado xanbaarsan wicitaanada OpenAI ama X-API-key + nooca anthropic.

YOUR_API_KEY

Hel Furahaaga API

Ilaali sirta muhiimka ah ee API Dib-u-soo-nooleynta waxay abuurtaa fure cusub waxayna burinaysaa kii hore.

Isticmaalkaaga

Ka eeg calaamada iyo isticmaalka ka raadi boggan markaad gasho akoonkaaga

-- Wicitaannada API

-- Calaamadaha la isticmaalay

Shannon API

Dulmar

Awoodaha

Beddelka Soo Gelida

Wacyigelinta Shaqada

Ku-dhismay Raadinta Shabakadda

Waxsoosaarka qaabaysan

Aalado kala-rogasho badan

Streaming

Bilaw degdeg ah

Deji URL-kaaga saldhiga

Ku dar furahaaga API

Dir fariintaada ugu horeysa

Qaabka jawaabta

Goobta ciyaarta API

Chat, Responses, Messages

Stream live output

Reuse your key

Xaqiijinta

Qaabka Fur AI (lagu taliyay)

Qaabka Anthropic

Qaababka

Wacyigelinta Shaqada

Xulashada Qalabka

Jawaabta Wacyigelinta Shaqada

Waxsoosaarka qaabaysan

Xulashada Qaabka Jawaabta

Streaming

Ku-dhismay Raadinta Shabakadda

Qaabka Anthropic

SDKs

FurAI-SDK-ku-wanaagsan

SDK-yada Anthropic-ku habboon

Khaladaadka Maareynta

Qaabka Jawaabta Khaladka

Changelog

Furahaaga API

Isticmaalkaaga

Shannon Coder (shannon-coder-1)

Diyaar ma u tahay inaad dhisto?