CLI کوڈنگ ٹولز

کوڈنگ ٹول کو Shannon کے ساتھ کام کرنے کے لیے تین سیٹنگز چاہییں: API کا بیس URL، آپ کی API کلید، اور ایک Shannon ماڈل id۔ یہ صفحہ Claude Code اور Codex CLI کے لیے درست سیٹنگز دیتا ہے، بتاتا ہے کہ کوڈنگ ماڈل shannon-coder-1 کی گنتی کیسے ہوتی ہے، اور ان ٹولز کو پیش آنے والے ایررز کی فہرست دیتا ہے۔

ہر ٹول کون سا endpoint استعمال کرتا ہے

تینوں endpoints ایک ہی API کلید لیتے ہیں، Authorization: Bearer کے طور پر یا x-api-key کے طور پر۔ یہ ٹولز جو anthropic-version، anthropic-beta اور openai-beta ہیڈرز بھیجتے ہیں وہ قبول کیے جاتے ہیں۔

Shannon ماڈل منتخب کریں

ہر درخواست میں ایسے ماڈل id کا نام ہونا چاہیے جو Shannon شائع کرتا ہے۔ کوڈنگ ٹول، جب تک آپ اسے نہ بتائیں، اپنے ڈیفالٹ ماڈل کا نام بھیجتا ہے، اور جو نام Shannon شائع نہیں کرتا اس کا جواب 400 اور پیغام unknown model: <name> سے دیا جاتا ہے۔ کوئی دوسرا نام Shannon ماڈل سے میپ نہیں کیا جاتا، اس لیے پہلی درخواست سے پہلے ٹول میں ماڈل سیٹ کریں۔

GET /v1/models ہر id کو اس کی کانٹیکسٹ ونڈو کے ساتھ درج کرتا ہے۔ اس کے لیے کلید کی ضرورت نہیں۔ ماڈلز اور قیمتیں

کوڈنگ ٹولز ماڈل کو لمبے سسٹم پرامپٹ سے چلاتے ہیں۔ سسٹم پرامپٹ کو shannon-coder-1، shannon-1.6-lite، shannon-1.6-pro، shannon-2-lite، shannon-2-pro اور ہوسٹڈ اوپن ویٹ ماڈلز لاگو کرتے ہیں، اس لیے کوڈنگ ٹول کے لیے ان میں سے کوئی منتخب کریں۔

Claude Code

Claude Code اپنا کنکشن environment variables سے پڑھتا ہے۔ انہیں اس شیل میں سیٹ کریں جو اسے شروع کرتا ہے، یا ~/.claude/settings.json کے env بلاک میں تاکہ وہ ہر سیشن کے لیے برقرار رہیں۔

# Install Claude Code
npm install -g @anthropic-ai/claude-code

# Where to send requests, and your Shannon API key
export ANTHROPIC_BASE_URL=https://api.shannon-ai.com
export ANTHROPIC_AUTH_TOKEN=YOUR_API_KEY

# Shannon model ids: the session model, and the model behind each built-in name
export ANTHROPIC_MODEL=shannon-coder-1
export ANTHROPIC_DEFAULT_OPUS_MODEL=shannon-coder-1
export ANTHROPIC_DEFAULT_SONNET_MODEL=shannon-coder-1
export ANTHROPIC_DEFAULT_HAIKU_MODEL=shannon-1.6-lite

# The context window of the session model
export CLAUDE_CODE_MAX_CONTEXT_TOKENS=131072

claude

{
  "env": {
    "ANTHROPIC_BASE_URL": "https://api.shannon-ai.com",
    "ANTHROPIC_AUTH_TOKEN": "YOUR_API_KEY",
    "ANTHROPIC_MODEL": "shannon-coder-1",
    "ANTHROPIC_DEFAULT_OPUS_MODEL": "shannon-coder-1",
    "ANTHROPIC_DEFAULT_SONNET_MODEL": "shannon-coder-1",
    "ANTHROPIC_DEFAULT_HAIKU_MODEL": "shannon-1.6-lite",
    "CLAUDE_CODE_MAX_CONTEXT_TOKENS": "131072"
  }
}

• تینوں ANTHROPIC_DEFAULT_…_MODEL variables سیٹ کریں۔ Subagents اور کچھ کمانڈز ماڈل کو اس کے بلٹ ان نام سے مانگتے ہیں، اور ہر نام کو ایک Shannon id پر پہنچنا چاہیے۔
• نمونہ بیک گراؤنڈ درخواستوں کو shannon-1.6-lite کی طرف کرتا ہے، جو ٹوکنز میں گنا جاتا ہے۔ اس طرح سیشن کے عنوانات اور ایسی ہی درخواستیں Coder کالز استعمال نہیں کرتیں۔
• Claude Code کانٹیکسٹ کے سائز کے لیے POST /v1/messages/count_tokens سے پوچھتا ہے۔ یہ endpoint ہوسٹڈ اوپن ویٹ ماڈلز کے لیے گنتی کرتا ہے۔ Shannon id کے ساتھ یہ 400 سے جواب دیتا ہے؛ Claude Code ٹوکن گنتی کو اختیاری سمجھتا ہے اور سائز کا اندازہ خود لگا لیتا ہے۔ ٹوکن گنتی

ٹول شروع کرنے سے پہلے پتہ، کلید اور ماڈل id جانچنے کے لیے ہاتھ سے ایک درخواست بھیجیں:

curl https://api.shannon-ai.com/v1/messages \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "shannon-1.6-lite",
    "max_tokens": 16,
    "messages": [{"role": "user", "content": "Say OK."}]
  }'

Codex CLI

Codex CLI Responses API سے بات کرتا ہے۔ ~/.codex/config.toml میں Shannon کو ماڈل پرووائیڈر کے طور پر بیان کریں، وہاں Shannon ماڈل id منتخب کریں، اور اپنی API کلید اس environment variable میں رکھیں جس کا نام پرووائیڈر دیتا ہے۔

model = "shannon-coder-1"
model_provider = "shannon"
model_context_window = 131072

[model_providers.shannon]
name = "Shannon"
base_url = "https://api.shannon-ai.com/v1"
env_key = "SHANNON_API_KEY"
wire_api = "responses"

# Install Codex CLI
npm install -g @openai/codex

# Your Shannon API key, under the name given as env_key
export SHANNON_API_KEY=YOUR_API_KEY

# Start it; --model selects another Shannon id for one run
codex
codex --model shannon-1.6-pro

• /v1/responses سرور پر کوئی گفتگو نہیں رکھتا: ہر درخواست گفتگو کو input میں لے کر آتی ہے۔ previous_response_id ہم آہنگی کے لیے قبول کیا جاتا ہے۔
• فنکشن ٹولز (type: "function") /v1/responses پر ماڈل کو پیش کیے جاتے ہیں۔
• /v1/responses پر shannon-coder-1 آپ کے بیلنس کے ٹوکنز میں گنا جاتا ہے، Coder کالز میں نہیں۔

Responses endpoint کے لیے وہی جانچ:

curl https://api.shannon-ai.com/v1/responses \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "shannon-1.6-lite",
    "input": "Say OK."
  }'

کوڈنگ ماڈل اور اس کی گنتی کیسے ہوتی ہے

shannon-coder-1 کوڈنگ ایجنٹس کے لیے Shannon ماڈل ہے۔ GET /v1/models اسے 131,072 ٹوکنز کی کانٹیکسٹ ونڈو، ٹول کالز، reasoning اور متن ان پٹ کے ساتھ رپورٹ کرتا ہے۔ اس کی گنتی دو طریقوں میں سے ایک سے ہوتی ہے، اس بات پر منحصر کہ ٹول کون سا endpoint استعمال کرتا ہے۔

کال ایک درخواست ہے، اس کا سائز کچھ بھی ہو۔ یہ درخواست قبول ہوتے ہی، ماڈل کے جواب دینے سے پہلے، گنی جاتی ہے۔ ایجنٹ سیشن ہر قدم کے لیے ایک درخواست بھیجتا ہے، اس لیے لمبا کام بہت سی کالز استعمال کرتا ہے۔ الاؤنس آپ کے پلان پر منحصر ہے اور ہر 4 گھنٹے بعد دوبارہ شروع ہوتا ہے، یعنی 00:00، 04:00، 08:00، 12:00، 16:00 اور 20:00 UTC پر۔

پلان کا صفحہ موجودہ اعداد دکھاتا ہے۔ پلانز

جب ونڈو کی کالز ختم ہو جائیں تو درخواست کا جواب 429 سے دیا جاتا ہے۔ /v1/messages پر وہی ایرر Anthropic کی شکل میں آتا ہے۔

{
  "error": {
    "type": "rate_limit_error",
    "message": "Shannon Coder call quota reached. Upgrade your plan at shannon-ai.com/plan"
  }
}

{
  "type": "error",
  "error": {
    "type": "rate_limit_error",
    "message": "Shannon Coder call quota reached. Upgrade your plan at shannon-ai.com/plan"
  }
}

کانٹیکسٹ اوور فلو

جب گفتگو ماڈل کی کانٹیکسٹ ونڈو سے بڑی ہو تو /v1/chat/completions اور /v1/messages جواب میں 400، type invalid_request_error، code context_length_exceeded اور prompt is too long سے شروع ہونے والا پیغام دیتے ہیں۔ کوڈنگ ٹولز یہ ایرر پڑھ کر سیشن کمپیکٹ کرتے ہیں اور درخواست دوبارہ بھیجتے ہیں۔ یہ shannon-coder-1، shannon-1.6-lite اور shannon-1.6-pro پیدا کرتے ہیں۔

{
  "error": {
    "type": "invalid_request_error",
    "code": "context_length_exceeded",
    "message": "prompt is too long: 140211 tokens > 131072 maximum",
    "param": null
  }
}

{
  "type": "error",
  "error": {
    "type": "invalid_request_error",
    "code": "context_length_exceeded",
    "message": "prompt is too long: 140211 tokens > 131072 maximum",
    "param": null
  }
}

پیغام prompt is too long: <sent> tokens > <limit> maximum ہوتا ہے۔ جب دونوں اعداد معلوم نہ ہوں تو یہ prompt is too long. Please compact the conversation and try again. ہوتا ہے۔

سٹریم پر اسٹیٹس پہلے ہی 200 ہوتا ہے، اس لیے ایرر ایونٹ کے طور پر آتا ہے اور سٹریم پھر عام طریقے سے بند ہو جاتی ہے:

data: {"error":{"message":"prompt is too long: 140211 tokens > 131072 maximum","type":"invalid_request_error","code":"context_length_exceeded","param":null}}

data: {"id":"chatcmpl-…","object":"chat.completion.chunk","created":…,"model":"shannon-coder-1","choices":[{"index":0,"delta":{},"finish_reason":"stop"}],"usage":{…}}

data: [DONE]

event: error
data: {"type":"error","error":{"type":"invalid_request_error","message":"prompt is too long: 140211 tokens > 131072 maximum"}}

event: message_delta
data: {"type":"message_delta","delta":{"stop_reason":"end_turn","stop_sequence":null},"usage":{…}}

event: message_stop
data: {"type":"message_stop"}

ایجنٹ لوپ کس پر بھروسا کر سکتا ہے

مسائل کا حل

آپ کی کلید اور آپ کا بیلنس Keys & usage صفحے پر ہیں۔ Keys & usage