لوگوی SHANNON A.I.
SHANNONA.I.
چتقیمت‌هاAPIتحقیقشرکتPentest AIStartup Boost

در حال بارگذاری رابط کاربری Shannon...

در حال بررسی وضعیت...
مستندات API

API Shannon

API هوش مصنوعی سازگار با OpenAI و Anthropic با فراخوانی توابع، جستجوی وب و خروجی‌های ساختاریافته.

دریافت کلید APIآزمایش PlaygroundV2
مستندات
  • نمای کلی
  • قابلیت‌ها
  • شروع سریع
  • پلی‌گراند APIجدید
  • احراز هویت
  • مدل‌ها
  • فراخوانی توابع
  • خروجی‌های ساختاریافته
  • استریم
  • جستجوی وب داخلی
  • فرمت Anthropic
  • SDKها
  • مدیریت خطا
  • تغییرات

Shannon AI API Documentation

نمای کلی

مستندات عمومی

هرآنچه برای راه‌اندازی با API سازگار Shannon با OpenAI و Anthropic نیاز دارید.

URL پایهسازگار با OpenAI
https://us-central1-shannonai.cloudfunctions.net/v1/chat/completions

از Chat Completions API با function calling و streaming استفاده کنید.

URL پایهسازگار با Anthropic
https://us-central1-shannonai.cloudfunctions.net/v1/messages

فرمت Claude Messages با tools و هدر anthropic-version.

هدرهااحراز هویت
مجوز: Bearer <کلید-شما>

یا برای درخواست‌های سبک Claude از X-API-Key به‌همراه anthropic-version استفاده کنید.

AccessStatus
Public docs - Key required to call

Streaming، function calling، خروجی ساختاریافته و جستجوی وب.

چک‌لیست راه‌اندازی
  • ✓
    SDK خود را به Shannon متصل کنید
    baseURL را روی endpoint مربوط به OpenAI یا Anthropic در بالا تنظیم کنید.
    Setup
  • ✓
    کلید API خود را اضافه کنید
    برای OpenAI از Bearer یا از X-API-Key + anthropic-version استفاده کنید.
    Security
  • ✓
    tools و خروجی ساختاریافته را فعال کنید
    از OpenAI tools/functions، JSON schema و web_search داخلی پشتیبانی می‌شود.
    قابلیت‌ها
  • ✓
    پیگیری مصرف
    پس از ورود، مصرف توکن و جستجو را در این صفحه ببینید.
    Analytics

قابلیت‌ها

OpenAI + Anthropic

جایگزین مستقیم APIهای OpenAI و Anthropic با پشتیبانی بومی از tools، خروجی ساختاریافته و جستجوی وب داخلی.

جایگزین آماده

سازگار

با SDKهای OpenAI و Anthropic کار می‌کند. فقط URL پایه را تغییر دهید.

فراخوانی توابع

ابزارها

ابزارها را تعریف کنید تا Shannon آن‌ها را فراخوانی کند. حالت‌های auto، forced و none پشتیبانی می‌شود.

جستجوی وب داخلی

جستجو

جستجوی وب هم‌زمان با ارجاع به منابع. به‌طور خودکار در دسترس است.

خروجی‌های ساخت‌یافته

JSON

حالت JSON و اعمال JSON Schema برای استخراج قابل اعتماد داده.

ابزارهای چندمرحله‌ای

ایجنتی

حلقه‌های اجرای خودکار تابع. تا ۱۰ تکرار در هر درخواست.

جریان

سریع

رویدادهای ارسال از سرور برای جریان بلادرنگ توکن‌ها.

شروع سریع

۵ دقیقه

در سه گام شروع کنید. Shannon کلاینت‌های OpenAI و Anthropic را شبیه‌سازی می‌کند.

1

URL پایه خود را تنظیم کنید

از endpoint سازگار با OpenAI استفاده کنید.

https://us-central1-shannonai.cloudfunctions.net/v1/chat/completions
2

کلید API خود را اضافه کنید

از Bearer auth در هدر Authorization استفاده کنید.

3

اولین پیام خود را ارسال کنید

زبان را انتخاب کنید و کلید خود را جایگزین کنید.

Python
from openai import OpenAI
client = OpenAI(
api_key="YOUR_API_KEY",
base_url="https://us-central1-shannonai.cloudfunctions.net/v1"
)
response = client.chat.completions.create(
model="shannon-balanced-grpo",
messages=[
{"role": "system", "content": "You are a helpful assistant."},
{"role": "user", "content": "Hello, Shannon!"}
],
max_tokens=1024
)
print(response.choices[0].message.content)

فرمت پاسخ

پاسخ موفق
{
  "id": "chatcmpl-abc123",
  "object": "chat.completion",
  "created": 1234567890,
  "model": "shannon-balanced-grpo",
  "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 شانون را مستقیم در مرورگر آزمایش کنید. درخواست بسازید، اجرا کنید و پاسخ را بلادرنگ ببینید.

Claude-style API studio

One polished workbench for every public endpoint.

Switch between Chat Completions, Responses, and Messages without changing pages. The request body, auth header, stream parser, and SDK snippets all follow the selected protocol.

Endpoints3
ThemeCrail / Pampas
Latest response IDNot captured yet
Composer

Chat Completions

Live response

/v1/chat/completions

Chat Completions Idle 0 SSE events No reasoning block
response_idWaiting for a response...
Ready to test.

Pick an endpoint, shape the payload, and run the request to inspect the live output.

0
SDK snippets

Keep the request, headers, and client syntax aligned with the selected endpoint.

JSON
{
"model": "shannon-balanced-grpo",
"messages": [
{
"role": "system",
"content": "You are Shannon. Answer crisply, commercially, and with strong structure."
},
{
"role": "user",
"content": "Outline a clean launch plan for a new AI API aimed at startup founders."
}
],
"max_tokens": 1024,
"temperature": 0.7,
"stream": true
}

احراز هویت

تمام درخواست‌های API نیاز به احراز هویت با کلید API Shannon شما دارند.

OpenAI Format (Recommended)

HTTP
Authorization: Bearer YOUR_API_KEY

فرمت Anthropic

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

مدل‌ها

Shannon چندین مدل بهینه‌شده برای کاربردهای مختلف ارائه می‌دهد.

shannon-balanced-grpoBalanced

Fast, efficient responses for everyday tasks

زمینه128K
بهترین برایChat, Q&A, Content Generation
shannon-deep-dapoDeep

Advanced reasoning for complex problems

زمینه128K
بهترین برایAnalysis, Research, Complex Tasks
shannon-coder-1Coder

Optimized for Claude Code CLI with call-based quota

زمینه128K
بهترین برایCode Generation, Tool Use, CLI Integration
Call-based quota

فراخوانی توابع

Define tools that Shannon can call to perform actions or retrieve information.

Python
from openai import OpenAI
import json
client = OpenAI(
api_key="YOUR_API_KEY",
base_url="https://us-central1-shannonai.cloudfunctions.net/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-balanced-grpo",
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}")

گزینه‌های انتخاب ابزار

"auto"Model decides whether to call a function (default)
"none"Disable function calling for this request
{"type": "function", "function": {"name": "..."}}Force a specific function call

پاسخ فراخوانی تابع

When model calls a function
{
  "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"
    }
  ]
}

خروجی‌های ساختاریافته

Force Shannon to respond with valid JSON that matches your schema.

Python
from openai import OpenAI
client = OpenAI(
api_key="YOUR_API_KEY",
base_url="https://us-central1-shannonai.cloudfunctions.net/v1"
)
# Force JSON output with schema
response = client.chat.completions.create(
model="shannon-balanced-grpo",
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"}

گزینه‌های قالب پاسخ

{"type": "json_object"}Force valid JSON output (no specific schema)
{"type": "json_schema", "json_schema": {...}}Force output matching your exact schema

استریم

Enable real-time token streaming with Server-Sent Events for responsive UIs.

Python
from openai import OpenAI
client = OpenAI(
api_key="YOUR_API_KEY",
base_url="https://us-central1-shannonai.cloudfunctions.net/v1"
)
# Enable streaming for real-time responses
stream = client.chat.completions.create(
model="shannon-balanced-grpo",
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)
نکته: Streaming responses arrive as Server-Sent Events. Each chunk contains a delta with partial content.

جستجوی وب داخلی

Shannon includes a built-in web_search function that's automatically available.

Python
from openai import OpenAI
client = OpenAI(
api_key="YOUR_API_KEY",
base_url="https://us-central1-shannonai.cloudfunctions.net/v1"
)
# Web search is automatically available!
# Shannon will use it when needed for current information
response = client.chat.completions.create(
model="shannon-balanced-grpo",
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
نکته حرفه‌ای: نتایج جستجوی وب شامل ارجاع هستند. Shannon منابع را خودکار نقل می‌کند.

فرمت Anthropic

Shannon از فرمت Anthropic Messages API نیز پشتیبانی می‌کند.

https://us-central1-shannonai.cloudfunctions.net/v1/messages
Python
import anthropic
client = anthropic.Anthropic(
api_key="YOUR_API_KEY",
base_url="https://us-central1-shannonai.cloudfunctions.net/messages"
)
response = client.messages.create(
model="shannon-balanced-grpo",
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)
هدر الزامی: Anthropic format requires anthropic-version: 2023-06-01.

SDKها

سازگار

Use any OpenAI or Anthropic SDK - just change the base URL.

OpenAI-Compatible SDKs

Python

Official OpenAI Python SDK - works with Shannon

pip install openai
View Docs
JavaScript / TypeScript

Official OpenAI Node.js SDK - works with Shannon

npm install openai
View Docs
Go

Community Go client for OpenAI-compatible APIs

go get github.com/sashabaranov/go-openai
View Docs
Ruby

Community Ruby client for OpenAI-compatible APIs

gem install ruby-openai
View Docs
PHP

Community PHP client for OpenAI-compatible APIs

composer require openai-php/client
View Docs
Rust

Async Rust client for OpenAI-compatible APIs

cargo add async-openai
View Docs

Anthropic-Compatible SDKs

Python (Anthropic)

Official Anthropic Python SDK - works with Shannon

pip install anthropic
View Docs
TypeScript (Anthropic)

Official Anthropic TypeScript SDK - works with Shannon

npm install @anthropic-ai/sdk
View Docs

مدیریت خطا

Shannon از کدهای وضعیت استاندارد HTTP استفاده می‌کند و خطاهای دقیق بازمی‌گرداند.

400درخواست نامعتبرفرمت یا پارامترهای درخواست نامعتبر است
401غیرمجازکلید API نامعتبر یا موجود نیست
402سهمیه تمام شدسهمیه توکن یا جستجو تمام شد
429محدودیت نرخدرخواست‌های زیاد، کندتر کنید
500خطای سرورخطای داخلی، بعداً دوباره تلاش کنید

فرمت پاسخ خطا

پاسخ خطا
{
  "error": {
    "message": "Invalid API key provided",
    "type": "authentication_error",
    "code": "invalid_api_key"
  }
}

تغییرات

Recent updates and improvements to the Shannon API.

v2.1.0
2025-01-03
  • جدیدAdded shannon-coder-1 model for Claude Code CLI integration
  • جدیدCall-based quota system for Coder model
  • ImprovedImproved function calling reliability
v2.0.0
2024-12-15
  • جدیدAdded Anthropic Messages API compatibility
  • جدیدMulti-turn tool execution (up to 10 iterations)
  • جدیدJSON Schema response format support
  • ImprovedEnhanced web search with better citations
v1.5.0
2024-11-20
  • جدیدAdded shannon-deep-dapo model for complex reasoning
  • جدیدBuilt-in web_search function
  • ImprovedReduced latency for streaming responses
v1.0.0
2024-10-01
  • جدیدInitial API release
  • جدیدOpenAI-compatible chat completions endpoint
  • جدیدFunction calling support
  • جدیدStreaming via Server-Sent Events

آماده ساخت هستید؟

Get your API key and start building with Shannon AI today.

دریافت کلید APIمشاهده قیمت‌ها