सीधे सामग्री पर जाएँ

एजेंट

अगर आपका इंटीग्रेशन कोई कोडिंग एजेंट लिख रहा है, तो सबसे पहले उसे https://occultapi.com/AGENTS.md दीजिए। यह छोटा-सा निर्देश है, जिसमें वे चार बातें हैं जिनमें एजेंट इस API के साथ बार-बार गलती करते हैं।

यह उसे दे दीजिए

एजेंट के काम शुरू करने से पहले इसे उसमें पेस्ट कर दीजिए। यह सादा markdown है, बिना ऑथेंटिकेशन के, CORS खुला है, इसलिए एजेंट इसे सीधे भी ले सकता है।

Read https://occultapi.com/AGENTS.md before writing any code against Occult API.
Use the OpenAPI spec at https://occultapi.com/openapi.json for exact field names.

इसमें क्या लिखा है, और क्यों

चार नियम, और हर एक इसलिए कि एजेंट यहाँ सच में यही गलतियाँ करते हैं। यह कोई आम स्टाइल गाइड नहीं है।

  • keys से एक साथ माँगें, लूप न चलाएँ। एक अनुरोध में कई गणनाएँ एक क्रेडिट में आती हैं; वही गणनाएँ अलग-अलग कॉल में हर एक पर एक क्रेडिट लेती हैं। साफ़-सुथरे कोड के चक्कर में एजेंट लूप लिख देगा, और उसका खर्च आपके बैलेंस से कटेगा।
  • 402 पर दोबारा कोशिश न करें। इसका मतलब है कि कुंजी सही है और बैलेंस ख़ाली है। जो एजेंट इसे थोड़ी देर की गड़बड़ी समझेगा, वह बार-बार कोशिश करता रहेगा, और जो इसे ऑथेंटिकेशन की त्रुटि समझेगा, वह एक बिल्कुल ठीक कुंजी बदल डालेगा। दोबारा कोशिश सिर्फ़ 429 और 5xx पर करें।
  • कुंजी सिर्फ़ सर्वर पर रहे। यह साफ़ लिखा गया है, क्योंकि “क्लाइंट से कॉल कर लो” सबसे आसान रास्ता लगता है, और उससे आपकी कुंजी सबके सामने आ जाती है।
  • स्पेक पढ़ें, फ़ील्ड के नाम अंदाज़े से न लिखें। OpenAPI दस्तावेज़ में हर फ़ील्ड, उसके मान्य मान और हर एंडपॉइंट का एक उदाहरण है, ज़्यादातर लाइव सर्वर पर जाँचा हुआ। एक बार स्पेक पढ़ना तीन बार 400 खाने से बेहतर है।

अगर आपका एजेंट MCP समझता है, तो वही बेहतर है

हमारा MCP सर्वर पाँच टूल के ज़रिए सभी 299 एंडपॉइंट देता है, और खोजने और स्कीमा पढ़ने में कोई क्रेडिट नहीं लगता, सिर्फ़ असली गणना में लगता है। एजेंट पूरा API मुफ़्त में देख सकता है और तभी खर्च करता है जब कुछ गणना करे। डॉक्स से अंदाज़ा लगवाने के मुक़ाबले यह सस्ता भी है और भरोसेमंद भी।

पहले ख़ुद पढ़ लीजिए

एजेंट को देने से पहले इसे दो मिनट ख़ुद पढ़ लेना ठीक रहेगा: /AGENTS.md। सलाह गलत निकली, तो पता आपको ही चलेगा।

आगे