SHANNON A.I. لوگو
SHANNONA.I.
چیٹقیمتAPIتحقیقکمپنیPentest AIStartup Boost

شینن انٹرفیس لوڈ ہو رہا ہے...

اسٹیٹس چیک ہو رہا ہے...
API دستاویزات

Shannon API

OpenAI اور Anthropic کے مطابق AI API، فنکشن کالنگ، ویب سرچ اور ساختی آؤٹ پٹس کے ساتھ۔

اپنی API کلید حاصل کریںپلے گراؤنڈ آزمائیںV2
دستاویزات
  • جائزہ
  • صلاحیتیں
  • فوری آغاز
  • API پلے گراؤنڈنیا
  • توثیق
  • ماڈلز
  • فنکشن کالنگ
  • ساختی آؤٹ پٹس
  • اسٹریمنگ
  • ویب تلاش
  • Anthropic
  • SDKs
  • غلطیاں
  • تبدیلیوں کا لاگ

Shannon AI API Documentation

جائزہ

عوامی ڈاکس

Shannon کے OpenAI اور Anthropic موافق API کے ساتھ شِپ کرنے کے لیے درکار سب کچھ۔

بنیادی URLOpenAI‑مطابق
https://us-central1-shannonai.cloudfunctions.net/v1/chat/completions

فنکشن کالنگ اور اسٹریمنگ کے ساتھ Chat Completions API استعمال کریں۔

بنیادی URLAnthropic‑مطابق
https://us-central1-shannonai.cloudfunctions.net/v1/messages

Claude Messages فارمیٹ ٹولز اور anthropic-version ہیڈر کے ساتھ۔

ہیڈرزتصدیق
تصدیق: Bearer <aap-ki-key>

یا Claude‑اسٹائل کالز کے لیے X-API-Key کے ساتھ anthropic-version۔

رسائیاسٹیٹس
عوامی ڈاکس - کال کرنے کے لیے کلید درکار ہے

اسٹریمنگ، فنکشن کالنگ، اسٹرکچرڈ آؤٹ پٹس، ویب سرچ۔

لانچ چیک لسٹ
  • ✓
    اپنے SDK کو Shannon کی طرف پوائنٹ کریں
    baseURL کو اوپر دیے گئے OpenAI یا Anthropic endpoints پر سیٹ کریں۔
    سیٹ اپ
  • ✓
    اپنی API کلید جوڑیں
    OpenAI کالز کے لیے Bearer ٹوکن یا X-API-Key + anthropic-version استعمال کریں۔
    سیکیورٹی
  • ✓
    ٹولز اور structured outputs فعال کریں
    OpenAI tools/functions، JSON schema، اور built-in web_search سپورٹ کرتا ہے۔
    صلاحیتیں
  • ✓
    استعمال ٹریک کریں
    جب آپ سائن اِن ہوں تو اس صفحے پر ٹوکن اور سرچ کی کھپت دیکھیں۔
    اینالٹکس

صلاحیتیں

OpenAI + Anthropic

OpenAI اور Anthropic API کے لیے drop‑in متبادل، ٹولز، ساختی آؤٹ پٹس اور بلٹ‑اِن ویب سرچ سپورٹ کے ساتھ۔

ڈراپ‑اِن ریپلیسمنٹ

مطابق

OpenAI اور Anthropic SDKs کے ساتھ کام کرتا ہے۔ بس base URL بدلیں۔

فنکشن کالنگ

ٹولز

ٹولز کی تعریف کریں، Shannon انہیں کال کرے گا۔ auto، forced، اور none موڈز سپورٹ۔

بلٹ‑اِن ویب سرچ

تلاش

ذرائع کے حوالوں کے ساتھ ریئل‑ٹائم ویب سرچ۔ خودکار دستیاب۔

اسٹرکچرڈ آؤٹ پٹس

JSON

قابلِ اعتماد ڈیٹا کے لیے JSON موڈ اور JSON Schema enforcement۔

ملٹی‑ٹرن ٹولز

ایجنٹک

خودکار فنکشن ایکزیکیوشن لوپس۔ ہر درخواست پر 10 iterations تک۔

اسٹریمنگ

تیز

ریئل‑ٹائم ٹوکن اسٹریمنگ کے لیے Server‑Sent Events۔

فوری آغاز

5 منٹ

تین مراحل میں شروع کریں۔ Shannon OpenAI اور Anthropic کلائنٹس کی نقل کرتا ہے۔

1

اپنا base URL سیٹ کریں

OpenAI‑مطابق endpoint استعمال کریں۔

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

اپنی API کلید شامل کریں

Authorization ہیڈر میں Bearer auth استعمال کریں۔

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 درخواستوں کے لیے آپ کی Shannon API کلید کے ذریعے توثیق ضروری ہے۔

OpenAI فارمیٹ (تجویز کردہ)

HTTP
Authorization: Bearer YOUR_API_KEY

Anthropic فارمیٹ

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

ماڈلز

Shannon مختلف استعمال کے لیے بہتر کیے گئے متعدد ماڈلز پیش کرتا ہے۔

shannon-balanced-grpoBalanced

روزمرہ کاموں کے لیے تیز، مؤثر جوابات

سیاق128K
اس کے لیے بہترینچیٹ، سوال و جواب، مواد کی تخلیق
shannon-deep-dapoDeep

پیچیدہ مسائل کے لیے جدید ریزننگ

سیاق128K
اس کے لیے بہترینتجزیہ، تحقیق، پیچیدہ کام
shannon-coder-1Coder

کال‑بیسڈ کوٹے کے ساتھ Claude Code CLI کے لیے آپٹمائزڈ

سیاق128K
اس کے لیے بہترینکوڈ جنریشن، ٹول استعمال، CLI انٹیگریشن
کال‑بیسڈ کوٹہ

فنکشن کالنگ

وہ ٹولز متعین کریں جنہیں Shannon کارروائیاں کرنے یا معلومات حاصل کرنے کے لیے کال کر سکے۔

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"ماڈل طے کرتا ہے کہ فنکشن کال کرنی ہے یا نہیں (ڈیفالٹ)
"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"
    }
  ]
}

ساختی آؤٹ پٹس

Shannon کو مجبور کریں کہ وہ آپ کے اسکیمہ کے مطابق درست JSON واپس کرے۔

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"}درست JSON آؤٹ پٹ لازمی کریں (بغیر مخصوص اسکیمہ)
{"type": "json_schema", "json_schema": {...}}آپ کے عین اسکیمہ سے ملتا آؤٹ پٹ لازمی کریں

اسٹریمنگ

ریئل‑ٹائم ٹوکن اسٹریمنگ کو Server‑Sent Events کے ساتھ فعال کریں تاکہ UI تیز ردعمل دے۔

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)
ٹِپ: اسٹریمنگ جوابات Server‑Sent Events کے طور پر آتے ہیں۔ ہر chunk میں جزوی مواد کے ساتھ delta ہوتا ہے۔

ویب تلاش

Shannon میں built‑in web_search فنکشن ہے جو خودکار طور پر دستیاب ہے۔

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 خودکار طور پر ذرائع کو cite کرے گا۔

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 فارمیٹ کے لیے anthropic-version: 2023-06-01 ضروری ہے۔

SDKs

مطابق

کسی بھی OpenAI یا Anthropic SDK کا استعمال کریں — صرف base URL تبدیل کریں۔

OpenAI‑مطابق SDKs

Python

آفیشل OpenAI Python SDK - Shannon کے ساتھ کام کرتا ہے

pip install openai
ڈاکس دیکھیں
JavaScript / TypeScript

آفیشل OpenAI Node.js SDK - Shannon کے ساتھ کام کرتا ہے

npm install openai
ڈاکس دیکھیں
Go

OpenAI‑مطابق APIs کے لیے کمیونٹی Go کلائنٹ

go get github.com/sashabaranov/go-openai
ڈاکس دیکھیں
Ruby

OpenAI‑مطابق APIs کے لیے کمیونٹی Ruby کلائنٹ

gem install ruby-openai
ڈاکس دیکھیں
PHP

OpenAI‑مطابق APIs کے لیے کمیونٹی PHP کلائنٹ

composer require openai-php/client
ڈاکس دیکھیں
Rust

OpenAI‑مطابق APIs کے لیے Async Rust کلائنٹ

cargo add async-openai
ڈاکس دیکھیں

Anthropic‑مطابق SDKs

Python (Anthropic)

آفیشل Anthropic Python SDK - Shannon کے ساتھ کام کرتا ہے

pip install anthropic
ڈاکس دیکھیں
TypeScript (Anthropic)

آفیشل Anthropic TypeScript SDK - Shannon کے ساتھ کام کرتا ہے

npm install @anthropic-ai/sdk
ڈاکس دیکھیں

غلطیاں

Shannon معیاری HTTP status codes استعمال کرتا ہے اور تفصیلی error messages واپس کرتا ہے۔

400غلط درخواستغلط درخواست فارمیٹ یا پیرامیٹرز
401غیر مجازغلط یا غائب API کلید
402کوٹہ ختمٹوکن یا سرچ کوٹہ ختم
429ریٹ لمٹبہت زیادہ درخواستیں، رفتار کم کریں
500سرور ایرراندرونی خرابی، بعد میں دوبارہ کوشش کریں

ایرر جواب فارمیٹ

ایرر جواب
{
  "error": {
    "message": "Invalid API key provided",
    "type": "authentication_error",
    "code": "invalid_api_key"
  }
}

تبدیلیوں کا لاگ

Shannon API کی تازہ ترین اپڈیٹس اور بہتریاں۔

v2.1.0
2025-01-03
  • نیاClaude Code CLI انٹیگریشن کے لیے shannon-coder-1 ماڈل شامل کیا
  • نیاCoder ماڈل کے لیے کال‑بیسڈ کوٹہ سسٹم
  • بہتر بنایافنکشن کالنگ کی قابلِ اعتمادیت بہتر کی
v2.0.0
2024-12-15
  • نیاAnthropic Messages API مطابقت شامل کی
  • نیاملٹی‑ٹرن ٹول ایکزیکیوشن (10 iterations تک)
  • نیاJSON Schema جواب فارمیٹ سپورٹ
  • بہتر بنایابہتر حوالہ جات کے ساتھ ویب سرچ بہتر کی
v1.5.0
2024-11-20
  • نیاپیچیدہ ریزننگ کے لیے shannon-deep-dapo ماڈل شامل کیا
  • نیاBuilt‑in web_search فنکشن
  • بہتر بنایااسٹریمنگ جوابات کی لیٹنسی کم کی
v1.0.0
2024-10-01
  • نیاابتدائی API ریلیز
  • نیاOpenAI‑مطابق chat completions endpoint
  • نیافنکشن کالنگ سپورٹ
  • نیاServer‑Sent Events کے ذریعے اسٹریمنگ

بنانے کے لیے تیار؟

اپنی API کلید حاصل کریں اور آج ہی Shannon AI کے ساتھ بنانا شروع کریں۔

API کلید بنائیںدستاویزات دیکھیں