AI ایجنٹس کے لیے: سیٹ اپ کی مرحلہ وار ہدایات — /docs/agents.md، دستاویزات کا انڈیکس — /llms.txt۔
AI ایجنٹس کے لیے
انٹیگریشن کسی AI ایجنٹ کے سپرد کیسے کریں: کسی بھی ٹول کے لیے تیار پرامپٹ۔ ذیل میں — دستاویزات کے مشین کے لیے پڑھنے کے قابل پتے اور ایک اسکل جو ایجنٹ ایک ہی کمانڈ سے انسٹال کرتا ہے۔
ایجنٹ کے لیے پرامپٹ#
یہ پرامپٹ اپنے AI ایجنٹ کو بھیجیں۔ یہ نیچے دی گئی ہدایات کے مطابق ٹول سیٹ اپ کرے گا اور کی آپ ہی سے مانگے گا۔
https://gate.joingonka.ai/docs/agents.md کی ہدایات کے مطابق اپنا ٹول کو JoinGonka Gateway سے جوڑیں — یہ Gonka نیٹ ورک کا OpenAI اور Anthropic کے ساتھ مطابقت رکھنے والا API ہے۔ کلید میں خود دوں گا: اسے ریپوزٹری کی فائلوں میں محفوظ نہ کریں اور گلوبل ماحول کے متغیرات تبدیل نہ کریں۔ آخر میں ایک مختصر درخواست سے کنکشن کی تصدیق کریں اور نتیجہ بتائیں۔نیچے ہدایات خود موجود ہیں۔ ایجنٹ انہیں /docs/agents.md سے Markdown کی شکل میں وصول کرتا ہے۔
اصول#
- API کی ایک انسان بناتا ہے — gate.joingonka.ai کے ڈیش بورڈ میں۔ خود اکاؤنٹ رجسٹر نہ کریں اور نہ کی بنائیں: کی صارف ہی سے مانگیں۔
- کی کو اپنے ٹرمینل سیشن کے
JOINGONKA_API_KEYانوائرنمنٹ ویری ایبل میں رکھیں۔ اسے git میں ٹریک ہونے والی فائلوں میں نہ لکھیں، نہ کمیٹ کریں اور نہ رپورٹ میں دکھائیں۔ - گلوبل
OPENAI_*اورANTHROPIC_*ویری ایبلز نہ بدلیں — نہ شیل پروفائل میں اور نہ سسٹم میں: صارف کے دیگر ٹولز انہیں پڑھتے ہیں۔ کی اور ایڈریس خود ٹول کی کانفگ میں لکھے جاتے ہیں — انسٹالر یہی کرتا ہے۔
حقائق#
- OpenAI API کلائنٹس کے لیے بیس URL:
https://gate.joingonka.ai/v1 - Anthropic API کلائنٹس کے لیے بیس URL،
/v1کے بغیر:https://gate.joingonka.ai - کلید
Authorization: Bearer jg-…یاx-api-key: jg-…ہیڈر میں بھیجی جاتی ہے - ماڈلز کو درخواستوں کی کی
jg-سے شروع ہوتی ہے؛ مینجمنٹ کیgm-ماڈلز تک نہیں جانے دیتی۔ - تجویز کردہ ماڈل:
MiniMaxAI/MiniMax-M2.7 - دستیاب ماڈلز کی فہرست:
GET https://gate.joingonka.ai/v1/models - فی کی 120 درخواستیں فی منٹ تک، حد سے زیادہ پر
Retry-Afterہیڈر کے ساتھ 429 جواب۔ حدود اور ٹائم آؤٹ —GET /v1/capabilitiesکے جواب میں،limitsفیلڈ میں۔
سیٹ اپ#
سیکشن کے آخر میں جدول میں صارف کا ٹول تلاش کریں۔ --tool ویلیو موجود ہو — انسٹالر سے سیٹ کریں، نہ ہو — گائیڈ دیکھ کر دستی طور پر۔
انسٹالر کے ذریعے#
بغیر سوال ایک کمانڈ: کی — انوائرنمنٹ ویری ایبل سے، ماڈل — فلیگ سے۔ انسٹالر ٹول کی کانفگ لکھے گا، پچھلی کی کاپی رکھے گا اور گیٹ وے پر ایک درخواست سے کنکشن جانچے گا۔
JOINGONKA_API_KEY=<key> npx -y @joingonka/setup --tool <id> --model MiniMaxAI/MiniMax-M2.7 --non-interactive| فلیگ | کیا کرتا ہے |
|---|---|
--tool <id> | کون سا ٹول سیٹ کرنا ہے — ٹولز کے جدول سے ویلیو۔ |
--model <id> | ماڈل آئی ڈی: تجویز کردہ — MiniMaxAI/MiniMax-M2.7، تمام دستیاب — GET /v1/models۔ |
--non-interactive | بغیر سوال: کی JOINGONKA_API_KEY سے لی جاتی ہے۔ |
--scope local | کانفگ موجودہ پروجیکٹ میں، ہوم ڈائریکٹری میں نہیں۔ صرف Claude Code کے لیے؛ کانفگ فائل .gitignore میں شامل کی جاتی ہے۔ |
--no-verify | کانفگ لکھنے کے بعد کنکشن نہ جانچیں۔ |
| ایگزٹ کوڈ | کیا مطلب ہے |
|---|---|
0 | مکمل: کانفگ لکھی گئی، جانچ کی درخواست کامیاب۔ نیٹ ورک یا بیلنس کی وجہ سے جانچ نہ ہو سکے تو انسٹالر انتباہ چھاپتا ہے، مگر کوڈ 0 کے ساتھ ہی باہر آتا ہے — صارف کو اس بارے میں بتائیں۔ |
1 | سیٹ اپ ناکام، وجہ آؤٹ پُٹ میں: مثلاً --tool کی نامعلوم ویلیو، JOINGONKA_API_KEY سیٹ نہیں یا کی jg- سے شروع نہیں ہوتی۔ |
2 | کانفگ لکھی گئی، مگر جانچ کی درخواست ناکام رہی: کی اور ماڈل آئی ڈی چیک کریں۔ |
ٹول چل رہا تھا تو دوبارہ چلائیں: کانفگ آغاز پر پڑھی جاتی ہے۔
دستی طور پر#
انسٹالر کے بغیر ٹول کے لیے اس کی گائیڈ کھولیں (لنک نیچے جدول میں) اور تین ویلیوز سیٹ کریں:
- بیس ایڈریس — OpenAI API کلائنٹس کے لیے
https://gate.joingonka.ai/v1یا Anthropic API کلائنٹس کے لیےhttps://gate.joingonka.ai; - کی — ٹول کی سیٹنگز میں API کی فیلڈ میں;
- ماڈل —
MiniMaxAI/MiniMax-M2.7یاGET /v1/modelsمیں سے کوئی اور۔
ٹولز اور گائیڈز#
| ٹول | --tool |
|---|---|
| Cursor | cursor |
| Claude Code | claude-code |
| OpenClaw | openclaw |
| OpenCode | opencode |
| Continue | continue |
| Cline | cline |
| Aider | aider |
| LangChain | — |
| n8n | — |
| Open WebUI | — |
| LibreChat | — |
| Hermes | hermes |
| Kilo Code | kilo |
| Roo Code | roo |
| LlamaIndex | — |
| PydanticAI | — |
| Vercel AI SDK | — |
| TanStack AI | — |
| ZCode | zcode |
| JetBrains | jetbrains |
| Copilot BYOK | copilot-byok |
| Zed | zed |
| Pi | pi |
| Codex CLI | codex |
| DeepSeek Harness | — |
| MiniMax Code | minimax-code |
| Warp | — |
| Trae | — |
| Cherry Studio | — |
| omp (Oh My Pi) | omp |
| OpenHands | — |
| Qwen Code | qwen-code |
| Goose | goose |
| Crush | crush |
| Zoo Code | zoo |
| Kimi Code | kimi-code |
| Factory Droid | droid |
| MiMo Code | mimo-code |
جانچ#
کی کی جانچ — بیلنس کی درخواست: یہ ٹوکن خرچ نہیں کرتی، کی JOINGONKA_API_KEY سے لی جاتی ہے:
curl -s https://gate.joingonka.ai/api/balance \
-H "Authorization: Bearer $JOINGONKA_API_KEY"ایڈریس، کی اور ماڈل کی جانچ — ماڈل کو ایک مختصر درخواست:
curl -s https://gate.joingonka.ai/v1/chat/completions \
-H "Authorization: Bearer $JOINGONKA_API_KEY" \
-H "Content-Type: application/json" \
-d '{"model": "MiniMaxAI/MiniMax-M2.7", "messages": [{"role": "user", "content": "Say OK"}], "max_tokens": 32}'ماڈل کے متن کے ساتھ 200 جواب یعنی کنکشن کام کر رہا ہے۔ انسٹالر خود یہی جانچ کرتا ہے: اس کے بعد ایگزٹ کوڈ 0 کافی ہے۔
کچھ ٹھیک نہ ہو تو#
خرابی جواب کی باڈی کے error فیلڈ میں آتی ہے — وجہ کی قسم اور متن کے ساتھ۔
| جواب | کیا کریں |
|---|---|
401 authentication_error | کی قبول نہیں ہوئی۔ دیکھیں کہ وہ پوری کاپی ہوئی اور Authorization: Bearer یا x-api-key میں بھیجی گئی؛ نئی کی صارف بناتا ہے۔ |
402 insufficient_funds | بیلنس میں رقم نہیں۔ صارف کو بتائیں: بیلنس ڈیش بورڈ میں بھرا جاتا ہے۔ |
402 child_key_limit_exceeded | چائلڈ کی کی حد ختم ہو گئی۔ کوئی اور کی یا بڑی حد درکار ہے — یہ کی کے مالک کا فیصلہ ہے۔ |
403 forbidden | یہ مینجمنٹ کی gm- ہے: ماڈلز تک نہیں جانے دیتی۔ jg- کی درکار ہے۔ |
400 invalid_request_error | درخواست میں خرابی۔ ماڈل نہ ملے تو خرابی کے متن میں دستیاب آئی ڈیز کی فہرست ہوتی ہے — وہاں سے یا GET /v1/models سے لیں۔ |
404 model_not_found | ایسا ماڈل اس وقت موجود نہیں — GET /v1/models میں سے کوئی اور چنیں۔ |
429 | بہت زیادہ درخواستیں یا نیٹ ورک مصروف۔ Retry-After ہیڈر میں جتنے سیکنڈ لکھے ہیں اتنے انتظار کریں اور دوبارہ کوشش کریں۔ |
503 model_unavailable | نیٹ ورک اس وقت یہ ماڈل پیش نہیں کر رہا۔ خرابی کے متن میں دیے گئے ماڈل پر یا GET /v1/models میں سے کسی اور پر جائیں۔ |
504 upstream_timeout | نیٹ ورک نے وقت پر جواب دینا شروع نہیں کیا۔ درخواست دہرائیں; لمبے جوابات کے لیے stream: true آن کریں۔ |
502 | گیٹ وے یا نیٹ ورک کی طرف خرابی — کی کا اس میں کوئی قصور نہیں۔ بعد میں دوبارہ کوشش کریں; نیٹ ورک کی حالت — نیٹ ورک کی حیثیت صفحے پر۔ |
تمام جوابی کوڈز اور حدود — خرابیاں اور حدود سیکشن میں۔
رپورٹ#
آخر میں صارف کو بتائیں:
- کون سا ٹول سیٹ ہوا اور کون سی کانفگ فائل لکھی گئی (پاتھ انسٹالر چھاپتا ہے، پچھلی کی کاپی ساتھ ہی);
- بنیادی ایڈریس اور ماڈل آئی ڈی؛
- جانچ کا نتیجہ: رسپانس کوڈ اور ماڈل کا جواب — یا جانچ کیوں ممکن نہ ہوئی؛
- صارف کو خود کیا کرنا باقی ہے: مثلاً ٹول دوبارہ شروع کرنا یا بیلنس بھرنا۔
رپورٹ میں کلید شامل نہ کریں۔
مشین ایڈریسز#
| ایڈریس | وہاں کیا ہے |
|---|---|
| /llms.txt | لینگویج ماڈلز کے لیے دستاویزات کا انڈیکس۔ |
| /llms-full.txt | تمام دستاویزات ایک ہی فائل میں۔ |
/docs/<page>.md | دستاویزات کے صفحے کا Markdown ورژن: وہی ایڈریس جس کے آخر میں .md ہو (/docs/models.md) یا Accept: text/markdown ہیڈر کے ساتھ صفحے کی درخواست۔ |
GET /v1/capabilities | گیٹ وے کی صلاحیتیں اور اس کی حدود — limits فیلڈ۔ |
GET /v1/models | ابھی دستیاب ماڈلز۔ |
GET /api/pricing | 1M ٹوکن پر فی ماڈل قیمتیں اور کمیشن۔ |
GET /v1/network-status | ماڈلز کی اسٹیٹس اور واقعات۔ |
ایجنٹ کے لیے اسکل#
ہدایات کو ایجنٹ میں اسکل (skill) کے طور پر انسٹال کیا جا سکتا ہے — پھر یہ بغیر پرامپٹ کے بھی اس کے پاس دستیاب رہے گی:
npx skills add https://gate.joingonka.ai