API संदर्भ
वर्कआइटम संचालन, निर्णय-चरण नियंत्रण, एकीकरण निष्पादन और टेलीमेट्री निर्यात के लिए संदर्भ।
ये API स्पष्ट नीति और किरायेदार दायरे के साथ पूर्वानुमानित स्वचालन व्यवहार के लिए डिज़ाइन किए गए हैं।
आधार समापन बिंदु
प्रमाणित अनुरोधों के लिए अपने कॉन्फ़िगर किए गए सार्वजनिक API एंडपॉइंट का उपयोग करें।
https://api.threada.ai प्रमाणीकरण और संदर्भ
- एपीआई एक्सेस के लिए स्कोप्ड क्रेडेंशियल्स का उपयोग करें
- जहां आवश्यक हो किरायेदार और भूमिका संदर्भ शामिल करें
- वैध संदर्भ के बिना अनुरोध बंद हो जाते हैं
विशिष्ट दायरे
- workitems:read और workitems:write
- नीति और निर्णय अपडेट के लिए workflow:manage
- नियंत्रित निष्पादन के लिए actions:execute
- निर्यात और विश्लेषण के लिए telemetry:read
पृष्ठांकन और फ़िल्टरिंग
- सूची समापन बिंदु कर्सर- या टोकन-आधारित पेजिनेशन का समर्थन करते हैं
- चैनल, वर्कफ़्लो, स्थिति, नीति संस्करण और समय सीमा के अनुसार फ़िल्टर करें
- बड़े टेलीमेट्री निर्यात के लिए बाउंडेड विंडो को प्राथमिकता दें
त्रुटि मॉडल
- सत्यापन, प्राधिकरण, नीति और निष्पादन विफलताओं के लिए टाइप की गई त्रुटि श्रेणियां
- कारण कोड ऑपरेटर टूलींग में नियतात्मक हैंडलिंग का समर्थन करते हैं
- क्रॉस-सर्विस जांच के लिए सहसंबंध आईडी वापस कर दी जाती हैं
उदाहरण अनुरोध
इनटेक पेलोड से एक वर्कआइटम बनाएं
वर्कफ़्लो प्रोसेसिंग के लिए एक कैनोनिकल कार्य रिकॉर्ड बनाएं। आवश्यकता पड़ने पर इनटेक चैनल के लिए चैनल पहचानकर्ता शामिल करें।
अनुरोध
curl -X POST "https://api.threada.ai/work-items" \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{\"workflow_id\":\"policy_review\",\"channel_id\":\"web_main\",\"payload\":{\"message\":\"Review this renewal request before approval\"}}" प्रतिक्रिया
{
"work_item_id": "wi_123",
"status": "new",
"workflow_id": "policy_review"
} एक अनुमोदित कार्रवाई निष्पादित करें
कॉन्फ़िगर किए गए एकीकरण के विरुद्ध नीति-अनुमोदित कार्रवाई चलाएँ।
अनुरोध
curl -X POST "https://api.threada.ai/actions/execute" \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "{\"work_item_id\":\"wi_123\",\"action_id\":\"request_approval\",\"integration_id\":\"int_workflow\"}" प्रतिक्रिया
{
"execution_id": "ex_456",
"status": "started",
"idempotency_key": "idem_789"
} कार्यान्वयन मार्गदर्शन की आवश्यकता है?
रोलआउट और शासन पैटर्न के लिए दस्तावेज़ों और तकनीकी अवलोकन का उपयोग करें।
तकनीकी टीम से संपर्क करें