Shannon AI API اسناد

کتنه

عامه اسناد

هرڅه چې تاسو ورته اړتیا لرئ د شینن د OpenAI او Anthropic مطابقت لرونکي API سره لیږدولو ته اړتیا لرئ.

بیس URL OpenAI - مطابقت لري

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

د فنکشن زنګ وهلو او سټیمینګ سره د چیټ تکمیل API وکاروئ.

بیس URL انتروپیک - مطابقت لري

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

د وسیلو او انتروپیک نسخه سرلیک سره کلاډ پیغامونه بڼه.

سرلیکونه تصدیق کول

واک ورکول: بییرر <your-key>

یا د کلاډ سټایل تلیفونونو لپاره د انټروپیک نسخه سره X-API-Key.

لاسرسی حالت

عامه اسناد - د زنګ وهلو لپاره اړین کلیدي

جریان کول، د فعالیت زنګ وهل، جوړښت شوي محصولات، ویب لټون.

د چک لیست پیل کړئ

+

خپل SDK په شینن کې په نښه کړئ

پورته OpenAI یا انټروپک پای ټکی ته baseURL تنظیم کړئ.

ترتیب
+

خپل API کیلي ضمیمه کړئ

د OpenAI زنګونو یا X-API-Key + انتروپیک نسخه لپاره بییرر ټیکونه وکاروئ.

امنیت
+

وسیلې او جوړښت شوي محصولات فعال کړئ

د OpenAI وسیلو/فعالیتونو ملاتړ کوي، JSON سکیما، او جوړ شوي ویب_لټون.

وړتیاوې
+

کارول تعقیب کړئ

په دې پاڼه کې د نښه کولو او لټون مصرف وګورئ کله چې خپل حساب ته ننوتل.

تجزیه

وړتیاوې

OpenAI + Anthropic

د وسیلو، جوړښت شوي محصولاتو، او جوړ شوي ویب لټون لپاره د اصلي ملاتړ سره د OpenAI او Anthropic APIs لپاره د ډراپ ان بدیل.

ډراپ-ان بدیل

مطابقت لري

د OpenAI او Anthropic SDKs سره کار کوي. یوازې د اساس URL بدل کړئ.

فنکشن زنګ وهل

وسیلې

وسیلې تعریف کړئ ، پریږدئ چې شینن ورته زنګ ووهي. د اتوماتیک ، جبري او هیڅ حالت ملاتړ کوي.

جوړ شوی ویب لټون

لټون

د سرچینې حوالې سره د ریښتیني وخت ویب لټون. په اتوماتيک ډول شتون لري.

جوړښت شوي محصولات

JSON

JSON حالت او JSON د اعتبار وړ ډیټا استخراج لپاره د سکیما پلي کول.

څو اړخیزه وسیلې

اجنټیک

د اتوماتیک فعالیت اجرا کولو لوپونه. په هره غوښتنه کې تر 10 تکرارونو پورې.

جریان

چټک

د ریښتیني وخت نښې سټرینګ لپاره د سرور لخوا لیږل شوي پیښې.

چټک پیل

۵ دقیقې

په دریو مرحلو کې پیل کړئ. شینن د OpenAI او انتروپیک پیرودونکو عکس العمل ښیې.

خپل بیس URL ترتیب کړئ

د OpenAI سره مطابقت لرونکی پای ټکی وکاروئ.

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

خپل API کیلي اضافه کړئ

د اختیار کولو سرلیک کې د بییرر سند وکاروئ.

خپل لومړی پیغام واستوئ

یوه ژبه غوره کړئ او خپل کیلي بدل کړئ.

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

د غبرګون بڼه

د بریالیتوب ځواب

{
  "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 لوبې ډګر

نوی

د شینن API مستقیم ستاسو په براوزر کې ازموینه وکړئ. خپله غوښتنه جوړه کړئ ، چل یې کړئ او په ریښتیني وخت کې ځواب وګورئ.

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.

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

د لوبې ډګر هڅه وکړئ V2 خپل API کیلي ترلاسه کړئ

تصدیق کول

ټولې API غوښتنې ستاسو د شینن API کیلي په کارولو سره تصدیق ته اړتیا لري.

د OpenAI بڼه (وړاندیز شوی)

HTTP

Authorization: Bearer YOUR_API_KEY

انتروپيک بڼه

HTTP

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

موډلونه

شینن ډیری ماډلونه وړاندیز کوي چې د مختلف کارولو قضیو لپاره مطلوب دي.

shannon-1.6-lite Shannon 1.6 Lite

د ورځني کارونو لپاره ګړندي او موثر ځوابونه

متن 128K

لپاره غوره خبرې اترې، پوښتنې او ځوابونه، د منځپانګې تولید

shannon-1.6-pro Shannon 1.6 Pro

د پیچلو ستونزو لپاره پرمختللي استدلال

متن 128K

لپاره غوره تحلیل، څیړنه، پیچلې دندې

shannon-2-lite Shannon 2 Lite

متن 128K

لپاره غوره

shannon-2-pro Shannon 2 Pro

متن 128K

لپاره غوره

shannon-coder-1 Shannon Coder

د کال پر بنسټ کوټې سره د کلاډ کوډ CLI لپاره غوره شوی

متن 128K

لپاره غوره د کوډ تولید، د وسیلې کارول، د CLI ادغام

د کال پر بنسټ کوټه

فنکشن زنګ وهل

هغه وسیلې تعریف کړئ چې شینن کولی شي د کړنو ترسره کولو یا معلوماتو ترلاسه کولو لپاره زنګ ووهي.

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

د وسیلې انتخاب اختیارونه

"auto" ماډل پریکړه کوي چې ایا فنکشن ته زنګ ووهي (ډیفالټ)

"none" د دې غوښتنې لپاره فنکشن زنګ بند کړئ

{"type": "function", "function": {"name": "..."}} د ځانګړي فعالیت زنګ مجبور کړئ

د فعالیت کال ځواب

کله چې ماډل یو فنکشن غږوي

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

جوړښت شوي محصولات

شینن مجبور کړئ چې د باوري JSON سره ځواب ورکړي چې ستاسو د سکیما سره سمون لري.

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

د ځواب فارمیټ اختیارونه

{"type": "json_object"} د اعتبار وړ JSON محصول (هیڅ ځانګړی سکیما)

{"type": "json_schema", "json_schema": {...}} ستاسو د دقیق سکیما سره مطابقت لرونکی محصول مجبور کړئ

جریان

د ځواب ویونکي UIs لپاره د سرور لخوا لیږل شوي پیښو سره د ریښتیني وخت ټوکن سټریمینګ فعال کړئ.

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

لارښوونه: د سټینګ ځوابونه د سرور لخوا لیږل شوي پیښو په توګه راځي. هره ټوټه د جزوي مینځپانګې سره ډیلټا لري.

جوړ شوی ویب لټون

شینن یو جوړ شوی web_search فنکشن شامل دی چې په اوتومات ډول شتون لري.

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

پرو لارښوونه: د ویب لټون پایلې کې حوالې شاملې دي. شینن به په اوتومات ډول سرچینې حواله کړي.

انتروپيک بڼه

شینن د انتروپیک پیغامونو 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);

اړین سرلیک: د انتروپیک بڼه د انتروپیک نسخه ته اړتیا لري: 2023-06-01.

SDKs

مطابقت لري

کوم OpenAI یا Anthropic SDK وکاروئ - یوازې د اساس URL بدل کړئ.

OpenAI-Compatible SDKs

SDK Python

رسمي OpenAI Python SDK - د شینن سره کار کوي

pip install openai

اسناد وګورئ ->

SDK JavaScript / TypeScript

رسمي OpenAI Node.js SDK - د شینن سره کار کوي

npm install openai

اسناد وګورئ ->

SDK Go

د OpenAI سره مطابقت لرونکي APIs لپاره د ټولنې Go مراجعین

go get github.com/sashabaranov/go-openai

اسناد وګورئ ->

SDK Ruby

د OpenAI سره مطابقت لرونکي APIs لپاره د ټولنې روبي پیرودونکي

gem install ruby-openai

اسناد وګورئ ->

SDK PHP

د OpenAI سره مطابقت لرونکي APIs لپاره د ټولنې PHP پیرودونکي

composer require openai-php/client

اسناد وګورئ ->

SDK Rust

د OpenAI سره مطابقت لرونکي APIs لپاره Async Rust مراجع

cargo add async-openai

اسناد وګورئ ->

د انتروپیک مطابقت لرونکي SDKs

SDK Python (Anthropic)

رسمي انتروپیک پایتون SDK - د شینن سره کار کوي

pip install anthropic

اسناد وګورئ ->

SDK TypeScript (Anthropic)

رسمي انتروپیک ټایپ سکریپټ SDK - د شینن سره کار کوي

npm install @anthropic-ai/sdk

اسناد وګورئ ->

د تېروتنې اداره کول

شینن د معیاري HTTP حالت کوډونه کاروي او مفصل خطا پیغامونه بیرته راولي.

400 ناوړه غوښتنه د غلطې غوښتنې بڼه یا پیرامیټونه

401 غیر مجاز ناسم یا ورک شوی API کیلي

402 کوټه زیاته شوه د ټکن یا لټون کوټه ډیره شوې

429 نرخ محدود ډیرې غوښتنې، سست

500 د سرور تېروتنه داخلي تېروتنه، وروسته بیا هڅه وکړئ

د خطا ځواب بڼه

د تېروتنې ځواب

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

بدلون

LOG

شینن API ته وروستي تازه معلومات او پرمختګونه.

v2.1.0

2025-01-03

نوی د کلاډ کوډ CLI ادغام لپاره د شینن کوډر -1 ماډل اضافه شوی
نوی د کوډر ماډل لپاره د کال پر بنسټ د کوټې سیسټم
ښه شوی د فعالیت زنګ وهلو اعتبار ښه شوی

v2.0.0

2024-12-15

نوی د انتروپیک پیغامونو API مطابقت اضافه شوی
نوی څو اړخیزه وسیله اجرا کول (تر 10 تکرارونو پورې)
نوی JSON د سکیما ځواب فارمیټ ملاتړ
ښه شوی د غوره حوالو سره د ویب لټون وده

v1.5.0

2024-11-20

نوی د پیچلي استدلال لپاره د شینن - ژور - ډیپو ماډل اضافه شوی
نوی جوړ شوی web_search فعالیت
ښه شوی د سټرینګ ځوابونو لپاره ځنډ کم شوی

v1.0.0

2024-10-01

نوی ابتدايي API خوشې کول
نوی د OpenAI سره مطابقت لرونکی چیټ پای ټکی
نوی د فنکشن زنګ ملاتړ
نوی د سرور لخوا لیږل شوي پیښو له لارې جریان کول

ستاسو د API کیلي

لاسرسی

د OpenAI زنګونو یا X-API-Key + انتروپیک نسخه لپاره بییرر ټیکونه وکاروئ.

YOUR_API_KEY

خپل API کیلي ترلاسه کړئ

خپل د API کلیدي پټ وساتئ. بیا تولید کول یو نوی کیلي رامینځته کوي او زاړه باطلوي.

ستاسو کارول

په دې پاڼه کې د نښه کولو او لټون مصرف وګورئ کله چې خپل حساب ته ننوتل.

-- API کالونه

-- کارول شوي ټکي

شینن API

کتنه

وړتیاوې

ډراپ-ان بدیل

فنکشن زنګ وهل

جوړ شوی ویب لټون

جوړښت شوي محصولات

څو اړخیزه وسیلې

جریان

چټک پیل

خپل بیس URL ترتیب کړئ

خپل API کیلي اضافه کړئ

خپل لومړی پیغام واستوئ

د غبرګون بڼه

د API لوبې ډګر

Chat, Responses, Messages

Stream live output

Reuse your key

تصدیق کول

د OpenAI بڼه (وړاندیز شوی)

انتروپيک بڼه

موډلونه

فنکشن زنګ وهل

د وسیلې انتخاب اختیارونه

د فعالیت کال ځواب

جوړښت شوي محصولات

د ځواب فارمیټ اختیارونه

جریان

جوړ شوی ویب لټون

انتروپيک بڼه

SDKs

OpenAI-Compatible SDKs

د انتروپیک مطابقت لرونکي SDKs

د تېروتنې اداره کول

د خطا ځواب بڼه

بدلون

ستاسو د API کیلي

ستاسو کارول

شینن کوډر (shannon-coder-1)

د جوړولو لپاره چمتو یاست؟

Shannon AI API Documentation

کتنه

وړتیاوې

ډراپ-ان بدیل

فنکشن زنګ وهل

جوړ شوی ویب لټون

جوړښت شوي محصولات

څو اړخیزه وسیلې

جریان

چټک پیل

خپل بیس URL ترتیب کړئ

خپل API کیلي اضافه کړئ

خپل لومړی پیغام واستوئ

د غبرګون بڼه

د API لوبې ډګر

Chat, Responses, Messages

Stream live output

Reuse your key

تصدیق کول

د OpenAI بڼه (وړاندیز شوی)

انتروپيک بڼه

موډلونه

فنکشن زنګ وهل

د وسیلې انتخاب اختیارونه

د فعالیت کال ځواب

جوړښت شوي محصولات

د ځواب فارمیټ اختیارونه

جریان

جوړ شوی ویب لټون

انتروپيک بڼه

SDKs

OpenAI-Compatible SDKs

د انتروپیک مطابقت لرونکي SDKs

د تېروتنې اداره کول

د خطا ځواب بڼه

بدلون

ستاسو د API کیلي

ستاسو کارول

شینن کوډر (shannon-coder-1)

د جوړولو لپاره چمتو یاست؟