RPC and API
बाहरी ऐप्स के लिए Gateway एकीकरण
बाहरी ऐप्स को आज OpenClaw से Gateway प्रोटोकॉल के माध्यम से बात करनी चाहिए। जब किसी स्क्रिप्ट, डैशबोर्ड, CI जॉब, IDE एक्सटेंशन, या किसी अन्य प्रक्रिया को एजेंट रन शुरू करने, इवेंट स्ट्रीम करने, परिणामों की प्रतीक्षा करने, काम रद्द करने, या Gateway संसाधनों की जांच करने की आवश्यकता हो, तो Gateway WebSocket और RPC विधियों का उपयोग करें।
आज क्या उपलब्ध है
| सतह | स्थिति | इसका उपयोग करें |
|---|---|---|
| Gateway प्रोटोकॉल | तैयार | WebSocket ट्रांसपोर्ट, कनेक्ट हैंडशेक, ऑथ स्कोप, प्रोटोकॉल वर्ज़निंग, और इवेंट। |
| Gateway RPC संदर्भ | तैयार | एजेंट, सेशन, टास्क, मॉडल, टूल, आर्टिफैक्ट, और अप्रूवल के लिए मौजूदा Gateway विधियां। |
openclaw agent |
तैयार | जब CLI को शेल आउट करना पर्याप्त हो, तब वन-शॉट स्क्रिप्ट इंटीग्रेशन। |
openclaw message |
तैयार | स्क्रिप्ट से संदेश या चैनल ऐक्शन भेजना। |
स्रोत ट्री में भविष्य की क्लाइंट लाइब्रेरी के लिए आंतरिक पैकेज कार्य मौजूद है, लेकिन वह सार्वजनिक इंस्टॉल सतह नहीं है। जब तक पैकेज प्रकाशित और वर्ज़न नहीं हो जाते, इसे प्रीव्यू कार्यान्वयन विवरण मानें।
अनुशंसित पथ
- Gateway चलाएं या खोजें।
- Gateway प्रोटोकॉल पर कनेक्ट करें।
- Gateway RPC संदर्भ से प्रलेखित RPC विधियां कॉल करें।
- जिस OpenClaw वर्ज़न के विरुद्ध आप परीक्षण करते हैं, उसे पिन करें।
- OpenClaw अपग्रेड करते समय RPC संदर्भ फिर से जांचें।
एजेंट रन के लिए, agent RPC से शुरू करें और जब आपको टर्मिनल परिणाम चाहिए हो,
तो इसे agent.wait के साथ जोड़ें। टिकाऊ बातचीत स्थिति के लिए, sessions.*
विधियों का उपयोग करें। UI इंटीग्रेशन के लिए, Gateway इवेंट की सदस्यता लें और केवल
उन इवेंट परिवारों को रेंडर करें जिन्हें आपका ऐप समझता है।
ऐप कोड बनाम Plugin कोड
जब कोड OpenClaw के बाहर रहता है, तो Gateway RPC का उपयोग करें:
- Node स्क्रिप्ट जो एजेंट रन शुरू करती हैं या उनका अवलोकन करती हैं
- CI जॉब जो Gateway कॉल करती हैं
- डैशबोर्ड और एडमिन पैनल
- IDE एक्सटेंशन
- बाहरी ब्रिज जिन्हें चैनल Plugin बनने की आवश्यकता नहीं है
- नकली या वास्तविक Gateway ट्रांसपोर्ट के साथ इंटीग्रेशन परीक्षण
जब कोड OpenClaw के अंदर चलता है, तो Plugin SDK का उपयोग करें:
- प्रोवाइडर Plugin
- चैनल Plugin
- टूल या लाइफ़साइकल हुक
- एजेंट हार्नेस Plugin
- विश्वसनीय रनटाइम हेल्पर
बाहरी ऐप्स को openclaw/plugin-sdk/* आयात नहीं करना चाहिए; ये सबपाथ
OpenClaw द्वारा लोड किए गए Plugin के लिए हैं।
