Sign inGet Started

llms.txt और Markdown दस्तावेज़

इस दस्तावेज़ साइट की हर सामग्री दो रूपों में मौजूद है: वह HTML जिसे आप पढ़ रहे हैं, और मशीनों के उपयोग के लिए बना Markdown। एजेंट्स को साफ़ और लिंक से भरपूर टेक्स्ट चाहिए, जिसे वे इंडेक्स कर सकें, प्राप्त कर सकें या कॉन्टेक्स्ट में लोड कर सकें। यह पेज मशीन-पठनीय तीनों रूपों और उनके आपसी संबंध को समझाता है।

सामग्री संग्रह

  • /llms.txt, यानी इंडेक्स: उत्पादों, डेवलपर गाइड, टूल और मशीन-पठनीय संदर्भों तक पहुँचने का चुना हुआ प्रवेश बिंदु। यह llms.txt परिपाटी का पालन करता है और इतना छोटा है कि कॉन्टेक्स्ट में समा जाता है। जब कोई एजेंट ज़रूरत के अनुसार पेज प्राप्त करता है, तो शुरुआत इसी से करें।
  • /llms-full.txt, यानी अंग्रेज़ी गाइड एक्सपोर्ट: लिखे गए अंग्रेज़ी दस्तावेज़, जो Markdown के रूप में एक साथ जोड़े गए हैं। इसमें जनरेट किए गए API ऑपरेशन संदर्भ, जनरेट किए गए SDK संदर्भ और आयात किए गए दस्तावेज़ शामिल नहीं हैं। जब आपके काम के लिए गाइड का बड़ा संग्रह चाहिए, तब इसका उपयोग करें।
  • हर पेज का Markdown रूप: हर पेज रॉ Markdown के रूप में भी उपलब्ध है, ताकि एजेंट बाकी संग्रह के बिना एक ही पेज प्राप्त कर सके।

गाइड एक्सपोर्ट और Markdown रूप उन्हीं प्रकाशित स्रोतों से बनते हैं जिनसे उनके HTML पेज बनते हैं। चुना हुआ इंडेक्स आपको उन्हीं स्रोतों तक ले जाता है। किसी खास काम के लिए सार्वजनिक GET एंडपॉइंट से दस्तावेज़ खोजें: q की जगह अपना प्रश्न लिखें, फिर मेल खाने वाला markdown_url प्राप्त करें। खोज पेज और सेक्शन के लिंक के साथ पेज के टोकन की अनुमानित संख्या भी लौटाती है।

Copy page सुविधा

आपको ये URL शायद ही याद रखने पड़ें। Guides, API संदर्भ, SDK और नॉलेज-बेस सेक्शन के हर पेज पर Copy page मेन्यू होता है, जो मशीन-पठनीय रूप सीधे आपके टूल्स को सौंप देता है:

  • Copy page as Markdown: मौजूदा पेज का Markdown रूप, जिसे चैट या कॉन्टेक्स्ट फ़ाइल में सीधे पेस्ट किया जा सकता है।
  • llms-full.txt खोलें: अंग्रेज़ी गाइड संग्रह, उन कार्यों के लिए जिनमें कई गाइड चाहिए।
  • MCP इंस्टॉल कमांड कॉपी करें: एक पंक्ति का कमांड जो होस्ट किए गए MCP सर्वर को आपके क्लाइंट के कॉन्फ़िग में जोड़ता है, ताकि पेज पढ़ने वाला एजेंट उस पर काम करने के लिए ज़रूरी टूल भी कनेक्ट कर सके।
  • Cursor से कनेक्ट करें / VS Code से कनेक्ट करें: दो आम एजेंटिक एडिटरों के लिए एक क्लिक में MCP सेटअप।

डैशबोर्ड इसी विचार का एक सीमित रूप देता है। ईमेल ऑनबोर्डिंग पेज पर Copy for AI मेनू मौजूदा कोड नमूने को पेस्ट करने के लिए तैयार प्रॉम्प्ट के रूप में कॉपी करता है, या उसे सीधे Cursor, Claude या ChatGPT में खोलता है।

API संदर्भ कभी पुराना नहीं पड़ता

API संदर्भ अनुभाग उसी OpenAPI स्पेसिफ़िकेशन से जनरेट होता है जो API को वैलिडेट करता है। इसका Markdown रूप भी इसी स्रोत से बनता है। ऑपरेशन सिग्नेचर और स्कीमा के लिए जनरेट किया गया संदर्भ या सार्वजनिक OpenAPI स्पेसिफ़िकेशन पढ़ें। अंग्रेज़ी गाइड एक्सपोर्ट में जनरेट किए गए ऑपरेशन पेज शामिल नहीं हैं। संदर्भ की संरचना देखने के लिए API संदर्भ परिचय से शुरू करें।

प्राइसिंग पेजों में उनकी कीमतें शामिल होती हैं

प्राइसिंग पेज और उसका Markdown रूप एक ही अनुरोध में, एक ही दर डेटा से रेंडर होते हैं। /email-api/pricing.md ईमेल प्लान और दोनों वॉल्यूम स्तर लौटाता है, /pricing/email.md हर भेजने के वॉल्यूम पर सेंडिंग-प्लान ग्रिड, /pricing/sms.md प्रति गंतव्य दर कार्ड, /pricing/voice/us.md किसी गंतव्य के लिए प्रति मिनट कॉल दरें, और /pricing/sms/fees.md कैरियर और 10DLC शुल्क। /pricing.md से शुरू करें: इसमें दर प्रकाशित करने वाला हर प्रोडक्ट, उसका प्राइसिंग पेज और वह .md URL सूचीबद्ध है जहाँ उसकी दरें मिलती हैं। बिलिंग कैटलॉग से आने वाली दरें फ़ाइल में कॉपी नहीं की जातीं, बल्कि आपके माँगने पर लाई जाती हैं, इसलिए Markdown रूप ऐसी कीमत नहीं दिखा सकता जिसे पेज पर बाद में बदल दिया गया हो। तालिकाओं में प्रकाशित मुद्रा और बिलिंग इकाई बताई जाती है। प्राइसिंग स्रोत द्वारा दी गई मुद्रा का उपयोग करें।

कौन सा रूप चुनें

आप चाहते हैं कि एजेंट…उसे दें…
जाने कि क्या उपलब्ध है और ज़रूरत पर पेज लाए/llms.txt
लिखी गई अंग्रेज़ी गाइड एक साथ पढ़े/llms-full.txt
किसी एक विषय को सटीक रूप से समझेCopy page से उस पेज का Markdown
Bird के बारे में केवल पढ़े नहीं, उस पर कार्रवाई भी करेMCP सर्वर; केवल डॉक्स से ईमेल नहीं भेजा जा सकता

MCP सर्वर इंस्टॉल करने, एडिटर कनेक्ट करने और कॉर्पस जोड़ने वाले चरण-दर-चरण सेटअप के लिए AI ऑनबोर्डिंग देखें।

अगले चरण

  • AI ऑनबोर्डिंग: MCP सर्वर इंस्टॉल करें, एडिटर कनेक्ट करें और कॉर्पस जोड़ें।
  • MCP सर्वर: आपका एजेंट Bird के बारे में पढ़ने के साथ उस पर कार्रवाई भी कर सके।
  • एजेंट स्किल्स: पहले से बने वर्कफ़्लो, जो कोडिंग एजेंट को Bird की सतह सिखाते हैं।

इस विषय के लिए दस्तावेज़, गाइड और उदाहरणों के साथ आगे बढ़ें।