AI एजेंट्स के लिए: सेटअप की चरण-दर-चरण गाइड — /docs/agents.md, दस्तावेज़ इंडेक्स — /llms.txt।
AI एजेंट के लिए
इंटीग्रेशन किसी AI एजेंट को कैसे सौंपें: किसी भी टूल के लिए तैयार प्रॉम्प्ट। नीचे — डॉक्युमेंटेशन के मशीन-पठनीय पते और एक स्किल जिसे एजेंट एक ही कमांड से इंस्टॉल करता है।
एजेंट के लिए प्रॉम्प्ट#
यह प्रॉम्प्ट अपने AI एजेंट को भेजें। यह नीचे दिए निर्देश से टूल सेट अप करेगा, और की आपसे माँगेगा।
अपना टूल को JoinGonka Gateway से कनेक्ट करो — यह Gonka नेटवर्क का OpenAI और Anthropic-संगत API है — निर्देश https://gate.joingonka.ai/docs/agents.md के अनुसार। कुंजी मैं खुद दूँगा: इसे रिपॉज़िटरी फ़ाइलों में सेव मत करो और ग्लोबल एनवायरनमेंट वेरिएबल मत बदलो। अंत में एक छोटे अनुरोध से कनेक्शन जाँचो और नतीजा बताओ।नीचे ख़ुद निर्देश है। एजेंट इसे /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