شعار SHANNON A.I.
SHANNONA.I.
دردشةالأسعارAPIأبحاثالشركةPentest AIStartup Boost

جاري تحميل واجهة Shannon...

جارٍ التحقق من الحالة...
توثيق واجهة API

واجهة Shannon API

واجهة ذكاء اصطناعي متوافقة مع OpenAI وAnthropic مع استدعاء الدوال، البحث في الويب، ومخرجات منظمة.

الحصول على مفتاح APIجرّب PlaygroundV2
التوثيق
  • نظرة عامة
  • الإمكانات
  • بدء سريع
  • ساحة لعب APIجديد
  • المصادقة
  • النماذج
  • استدعاء الدوال
  • مخرجات منظمة
  • البث
  • بحث ويب مدمج
  • تنسيق Anthropic
  • حزم SDK
  • معالجة الأخطاء
  • سجل التغييرات

Shannon AI API Documentation

نظرة عامة

توثيق عام

كل ما تحتاجه للإطلاق باستخدام واجهة 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 <مفتاحك>

أو استخدم X-API-Key مع anthropic-version لطلبات بأسلوب Claude.

AccessStatus
Public docs - Key required to call

Streaming و function calling ومخرجات منظمة وبحث ويب.

قائمة الإطلاق
  • ✓
    وجّه SDK إلى Shannon
    اضبط baseURL على endpoint الخاص بـ OpenAI أو Anthropic أعلاه.
    Setup
  • ✓
    أضف مفتاح API الخاص بك
    استخدم Bearer لـ OpenAI أو X-API-Key + anthropic-version.
    Security
  • ✓
    فعّل tools والمخرجات المنظمة
    يدعم OpenAI tools/functions و JSON schema و web_search المدمج.
    الإمكانات
  • ✓
    تتبّع الاستخدام
    اعرض استهلاك التوكنات والبحث في هذه الصفحة بعد تسجيل الدخول.
    Analytics

الإمكانات

OpenAI + Anthropic

بديل مباشر لواجهات OpenAI و Anthropic مع دعم أصلي لـ tools والمخرجات المنظمة والبحث المدمج في الويب.

بديل مباشر

متوافق

يعمل مع SDK الخاصة بـ OpenAI وAnthropic. ما عليك سوى تغيير عنوان URL الأساسي.

استدعاء الدوال

أدوات

عرّف الأدوات ودع Shannon تستدعيها. يدعم أوضاع auto وforced وnone.

بحث ويب مدمج

بحث

بحث ويب فوري مع الاستشهاد بالمصادر. متاح تلقائيًا.

مخرجات مُهيكلة

JSON

وضع JSON وفرض JSON Schema لاستخراج بيانات موثوق.

أدوات متعددة الأدوار

وكيل

حلقات تنفيذ وظائف تلقائية. حتى 10 تكرارات لكل طلب.

بث مباشر

سريع

أحداث Server‑Sent لبث التوكنات في الوقت الحقيقي.

بدء سريع

5 دقائق

ابدأ في ثلاث خطوات. Shannon يعكس عملاء OpenAI وAnthropic.

1

عيّن عنوان URL الأساسي

استخدم نقطة نهاية متوافقة مع OpenAI.

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

أضف مفتاح API

استخدم مصادقة Bearer في ترويسة 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

جديد

اختبر واجهة Shannon 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عرض الأسعار