प्लेटफ़ॉर्म · API और वेबहुक

स्लाइड नहीं, HTTPS से एकीकरण

सर्वर-टू-सर्वर चैट लागू करें, अपने UI में टोकन स्ट्रीम करें, FlexyAgents होस्ट पर समाप्त होने वाले वेबहुक से ऑटोमेशन चलाएँ। नीचे के पथ वास्तविक Next.js हैंडलर हैं — FlexyAgents API कनेक्शन बनाएँ, फिर तैनाती स्क्रीन से मान कॉपी करें।

  • POST /api/agents/{agentId}/chat FlexyAgents automation-app कनेक्शन से जुड़ी Bearer टोकन स्वीकार करता है, फिर विजेट जैसा ही RAG + मॉडल स्टैक चलाता है
  • वैकल्पिक स्ट्रीमिंग न्यूलाइन-सीमांकित JSON खंड लौटाती है; गैर-स्ट्रीमिंग प्रतिक्रियाएँ एक सहायक payload में समेट जाती हैं
  • प्रति-IP दर सीमाएँ प्लान जाँच से पहले लागू होती हैं; होस्टेड प्लान टोकन बजट लागू करते हैं और BYOK प्लान प्रदाता कुंजी गायब होने पर स्पष्ट त्रुटियाँ लौटाते हैं
  • वेबहुक ट्रिगर, चैनल कॉलबैक और आउटबाउंड एकीकरण वही tenancy मॉडल साझा करते हैं — सब संगठन और एजेंट रिकॉर्ड पर हल होते हैं
दस्तावेज़ पढ़ेंडेवलपर हब

पहले कुंजी चाहिए? वर्कस्पेस बनाएँ के बाद सेटिंग → API कुंजी या एजेंट कनेक्शन मोडल खोलें।

HTTP एंडपॉइंट एक नज़र में

पथ Next.js रूट ट्री को दर्शाते हैं — तैनाती स्क्रीन के एजेंट ID और होस्ट से प्लेसहोल्डर बदलें।

  • POST/api/agents/{agentId}/chat

    एजेंट चैट और स्ट्रीमिंग

    messages सरणी (role + content) और वैकल्पिक stream ध्वज के साथ JSON बॉडी भेजें। Bearer प्रमाणीकरण एजेंट कनेक्शन पर संग्रहीत FlexyAgents API कुंजी के विरुद्ध मान्य करता है; सफल कुंजी प्रमाणीकरण संगठन को स्वतः हल करता है।

  • POST/api/webhooks/automations/...

    स्वचालन ट्रिगर प्रवेश

    प्रकाशित स्वचालन वेबहुक URL उजागर कर सकते हैं जो payload को deserialize करके executeAutomation कॉल करते हैं — जब आपकी स्वयं की सेवाओं को OAuth के बिना प्रवाह शुरू करने की आवश्यकता हो।

  • GET/POST/api/webhooks/*

    चैनल और प्रदाता वेबहुक

    /api/webhooks के अंतर्गत sibling रूट WhatsApp, Instagram, Facebook Messenger, आने वाले ईमेल और समान विक्रेता कॉलबैक संभालते हैं ताकि omnichannel परिनियोजन आपके डोमेन पर रहें।

  • —एकीकरण → वेबहुक

    आउटबाउंड वितरण

    जब आप चाहें कि FlexyAgents बातचीत या सिस्टम घटनाएँ आपके SIEM, data lake या टिकटिंग ब्रिज पर धकेले, डैशबोर्ड से हस्ताक्षरित आउटबाउंड वेबहुक कॉन्फ़िगर करें।

न्यूनतम गैर-स्ट्रीमिंग कॉल

curl -X POST "https://YOUR_APP_HOST/api/agents/AGENT_ID/chat" \
  -H "Authorization: Bearer YOUR_FLEXYAGENTS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"messages":[{"role":"user","content":"Hello"}],"stream":false}'

उस एजेंट पर FlexyAgents ऐप कनेक्ट करने के बाद तैनाती → API से कॉपी किए मानों से बदलें।

आह्वान

विजेट जैसा ही मस्तिष्क — HTTPS-प्रथम चैट

परिनियोजन स्क्रीन आपके लाइव होस्ट के विरुद्ध curl स्निपेट कॉपी करती है। अंदर हैंडलर automation connection store से API कुंजियाँ मान्य करता है, व्यवहार + ज्ञान लोड करता है, और अन्य चैनलों की तरह उपयोग बढ़ाता है।

  • Messages सरणी अनुबंध

    बॉडी में कम से कम एक चैट टर्न होना चाहिए। निष्पादक पुनर्प्राप्ति के लिए इतिहास को नवीनतम उपयोगकर्ता संदेश तक काटता है, फिर भी भविष्य के लिए बहु-टर्न सरणियाँ स्वीकार करता है।

    • सत्यापक में भूमिकाएँ user, assistant या system तक सीमित
    • हेडर मेटाडेटा केवल प्रलेखित होने पर जोड़ें — पहले JSON अनुबंध पर टिके रहें
    • अमान्य आकार तेज़ डिबगिंग के लिए Zod विवरण स्ट्रिंग के साथ 400 लौटाते हैं
    Deployment टैब खोलें

  • स्ट्रीमिंग मोड

    stream: true सेट करें ताकि NDJSON खंड (प्रति पंक्ति एक JSON ऑब्जेक्ट) मिलें जिन्हें फ्रंटएंड टोकन आने पर UI में भेज सकें।

    • होस्टेड विजेट समता चाहने वाले मोबाइल या डेस्कटॉप क्लाइंट के लिए आदर्श
    • मध्य-स्ट्रीम त्रुटियाँ भी JSON पंक्तियों के रूप में क्रमबद्ध होती हैं ताकि पार्सर पुनर्प्राप्त कर सकें
    • जब प्रॉक्सी प्रतिक्रियाओं को आक्रामक रूप से बफ़र करें तो स्ट्रीमिंग बंद करें

  • Bearer API कुंजियाँ बनाम सत्र कुकी

    सेवा खातों को प्रति एजेंट उत्पन्न FlexyAgents कनेक्शन कुंजी उपयोग करनी चाहिए। इंटरैक्टिव परीक्षक प्रमाणित डैशबोर्ड सत्र पर निर्भर हो सकते हैं, लेकिन सर्वर-से-सर्वर कॉल हमेशा Bearer टोकन उपयोग करें।

    • कुंजियाँ अन्य स्वचालन क्रेडेंशियल के साथ विश्राम पर एन्क्रिप्ट होती हैं
    • कुंजी घुमाने से आपके URL में एजेंट ID नहीं बदलता
    • अमान्य या गायब कुंजियाँ किसी भी मॉडल व्यय से पहले 401 लौटाती हैं
    मॉडल बिलिंग संदर्भ

  • उत्पादन में दिखने वाली सीमाएँ

    Redis-समर्थित दर सीमाएँ ट्रैफ़िक बढ़ने पर 429 लौटाती हैं। प्लान प्रवर्तन होस्टेड/BYOK मासिक सीमाओं के लिए MESSAGE_LIMIT_REACHED और होस्टेड अनुमान के लिए टोकन छत जोड़ता है।

    • स्वचालन और चैट वही संगठन-स्तरीय लेखांकन कहानी साझा करते हैं
    • सहायता से बात करते समय त्रुटि payload से सहसंबंध ID लॉग करें
    • जहाँ बिलिंग अतिरिक्त थ्रूपुट अनुमति दे, अपग्रेड करें या क्रेडिट जोड़ें
    उपयोग और प्लान

घटनाएँ

अपना स्टैक FlexyAgents तक लाएँ — और घटनाएँ वापस बाहर भेजें

इनबाउंड रूट विक्रेता हस्ताक्षर सामान्यीकृत करते हैं जबकि आउटबाउंड कॉन्फ़िगरेशन अन्य एकीकरणों के पास रहता है। स्वचालन प्रवाह के भीतर मनमाना HTTP भी POST कर सकते हैं।

  • स्वचालन वेबहुक ट्रिगर

    जब कोई प्रवाह वेबहुक ट्रिगर प्रकाशित करता है, FlexyAgents पथ खंड संग्रहीत करता है और पार्स किए गए बॉडी के साथ executeAutomation कॉल करने से पहले payload सत्यापित करता है।

    • Slack, CRM या कस्टम REST endpoint कॉल करने वाले एजेंट चरणों के साथ जोड़ें
    • सामान्य प्रवेश सक्षम करने से पहले अपग्रेडेड प्लान की आवश्यकता हो सकती है
    • लॉग OAuth ट्रिगर जैसी ही स्वचालन रन इतिहास में दिखते हैं
    स्वचालन अवलोकन

  • चैनल प्रदाता कॉलबैक

    WhatsApp, Instagram DM, Messenger और आने वाला ईमेल प्रत्येक सार्वजनिक HTTPS endpoint पंजीकृत करते हैं ताकि Meta, Twilio या मेल प्रदाता घटनाएँ सत्यापित और वितरित कर सकें।

    • विक्रेता कंसोल में कॉलबैक URL अपने परिनियोजन होस्ट से मिलाएँ
    • सत्यापन हैंडशेक लाइव ट्रैफ़िक के समान रूट पर होते हैं
    • अनुपालन-संवेदनशील payload उसी अवसंरचना पर रखते हैं जिसकी आप पहले से ऑडिट करते हैं
    चैनल परिनियोजन

  • आउटबाउंड HTTP क्रियाएँ

    स्वचालन क्रियाएँ टेम्पलेटेड बॉडी के साथ ग्राहक-स्वामित्व वाले URL पर POST या PUT कर सकती हैं — पहले पक्षीय कनेक्टर की प्रतीक्षा किए बिना “Opsgenie सूचित करें” या “Jira टिकट बनाएँ” सोचें।

    • स्वचालन बिल्डर से ट्रिगर फ़ील्ड JSON बॉडी में मैप करें
    • पुनः प्रयास और त्रुटि प्रबंधन स्वचालन निष्पादक डिफ़ॉल्ट का अनुसरण करते हैं
    • वितरण से पहले मानव-पठनीय सारांश के लिए एजेंट चरणों के साथ मिलाएँ

संदर्भ

स्पेक, दस्तावेज़ और अन्वेषण उपकरण

मार्केटिंग पृष्ठ कथात्मक रहते हैं; इंजीनियरों को docs साइट, रिपॉ में इनलाइन OpenAPI परिभाषाएँ, और परिनियोजन पृष्ठ स्निपेट पर निर्भर रहना चाहिए जो हमेशा आपके tenant ID से मेल खाते हैं।

  • दस्तावेज़ीकरण केंद्र

    अवधारणात्मक मार्गदर्शिकाओं के लिए /docs से शुरू करें, फिर त्वरित शुरुआत, प्रमाणीकरण परिचय और उपलब्ध होने पर टैब्ड संदर्भ के लिए डेवलपर-केंद्रित /api पृष्ठ से क्रॉस-लिंक करें।

    • उदाहरण curl, JavaScript और विजेट एम्बेड पैटर्न पर ज़ोर देते हैं
    • SDK और Postman वादे वास्तव में शिप किए गए डाउनलोड से मेल खाने चाहिए
    • अंतराल सहायता के माध्यम से रिपोर्ट करें ताकि मार्केटिंग और तकनीकी लेखक संरेखित रहें
    दस्तावेज़ खोलें

  • OpenAPI सत्य का स्रोत

    रिपॉज़िटरी में auth स्कीम, चैट payload और सहायक REST संसाधनों का वर्णन करने वाला व्यापक OpenAPI दस्तावेज़ है — उस फ़ाइल से क्लाइंट बनाएँ या Postman में आयात करें।

    • संस्करणीकरण इस लैंडिंग पृष्ठ नहीं, पैकेज रिलीज़ लय का अनुसरण करता है
    • स्टेजिंग और उत्पादन आधार URL स्पेक servers सूची में गिने जाते हैं
    • स्थानीय डेवलपर localhost पर वही /api/agents/{id}/chat पथ उपयोग करते हैं जो उत्पादन आपके tenant होस्ट पर उपयोग करता है
    डेवलपर API पृष्ठ

  • विजेट और मोबाइल साथी

    हर अनुभव को कच्चा REST नहीं चाहिए — एम्बेडेबल स्क्रिप्ट विज़िटर संदर्भ के साथ उसी चैट endpoint को कॉल करती है। वेब स्व-सेवा प्लस बैकएंड जॉब चाहते हों तो API पहुँच को विजेट के साथ जोड़ें।

    • होस्टेड पृष्ठ आपके पहले से परीक्षित एजेंट कॉन्फ़िगरेशन का पुनः उपयोग करते हैं
    • CSP और कुकी नीतियाँ आपके कॉन्फ़िगर विजेट मूल की अनुमति दें
    • ईमेल से गहरे लिंक क्वेरी पैरामीटर के साथ होस्टेड चैट खोल सकते हैं
    वेब सतहें

API को ऑटोमेशन, चैनल, विश्लेषण की गवर्नेंस के साथ उपयोग करें।

अगला कदम

कार्यशील curl कॉपी करें, फिर प्रोडक्शन के लिए मज़बूत करें

FlexyAgents कनेक्शन कुंजी बनाएँ, अपने सीक्रेट स्टोर में पेस्ट करें, और ऑटोमेशन वेबहुक को अपने स्वामित्व वाले पथ पर इंगित करें। तैयार होने पर सफल टीमों द्वारा उपयोग किए जाने वाले समान विश्लेषण वर्कस्पेस से अवलोकन क्षमता जोड़ें।

मुफ़्त आज़माएँडेमो बुक करें