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

API संदर्भ

WorkItem संचालन, निर्णय-चरण नियंत्रण, इंटीग्रेशन निष्पादन और टेलीमेट्री एक्सपोर्ट के लिए संदर्भ।

ये API स्पष्ट पॉलिसी और टेनेंट स्कोपिंग के साथ पूर्वानुमानित ऑटोमेशन व्यवहार के लिए डिज़ाइन किए गए हैं।

आधार एंडपॉइंट

प्रमाणित अनुरोधों के लिए अपने कॉन्फ़िगर किए गए सार्वजनिक API एंडपॉइंट का उपयोग करें।

https://api.threada.ai

प्रमाणीकरण और संदर्भ

  • API एक्सेस के लिए स्कोप्ड क्रेडेंशियल का उपयोग करें
  • जहाँ आवश्यक हो टेनेंट और रोल संदर्भ शामिल करें
  • वैध संदर्भ के बिना अनुरोध फेल-क्लोज़्ड हो जाते हैं

विशिष्ट स्कोप

  • workitems:read और workitems:write
  • पॉलिसी और निर्णय अपडेट के लिए workflow:manage
  • नियंत्रित निष्पादन के लिए actions:execute
  • एक्सपोर्ट और विश्लेषण के लिए telemetry:read

पेजिनेशन और फ़िल्टरिंग

  • लिस्ट एंडपॉइंट कर्सर- या टोकन-आधारित पेजिनेशन का समर्थन करते हैं
  • चैनल, वर्कफ़्लो, स्थिति, पॉलिसी संस्करण और समय सीमा के अनुसार फ़िल्टर करें
  • बड़े टेलीमेट्री एक्सपोर्ट के लिए बाउंडेड विंडो को प्राथमिकता दें

त्रुटि मॉडल

  • सत्यापन, प्राधिकरण, पॉलिसी और निष्पादन विफलताओं के लिए टाइप की गई त्रुटि श्रेणियाँ
  • रीज़न कोड ऑपरेटर टूलिंग में नियतात्मक हैंडलिंग का समर्थन करते हैं
  • क्रॉस-सर्विस जाँच के लिए कोरिलेशन ID लौटाई जाती हैं

उदाहरण अनुरोध

इनटेक पेलोड से एक WorkItem बनाएँ

वर्कफ़्लो प्रोसेसिंग के लिए एक कैनोनिकल कार्य रिकॉर्ड बनाएँ। आवश्यकता पड़ने पर इनटेक चैनल के लिए चैनल पहचानकर्ता शामिल करें।

अनुरोध
curl -X POST "https://api.threada.ai/api/v1/public/work-items" \
  -H "X-API-Key: <api-key>" \
  -H "Content-Type: application/json" \
  -d "{\"subject\":\"Review renewal request\",\"channel\":\"web\",\"channel_id\":\"web_main\",\"initial_message\":{\"role\":\"user\",\"content\":\"Review this renewal request before approval\"},\"tags\":[\"policy_review\"]}"
प्रतिक्रिया
{
  "work_item": {
    "summary": {
      "work_item_id": "wi_123",
      "status": "new",
      "subject": "Review renewal request"
    }
  }
}

एक अनुमोदित कार्रवाई निष्पादित करें

कॉन्फ़िगर किए गए इंटीग्रेशन के विरुद्ध पॉलिसी-अनुमोदित कार्रवाई चलाएँ।

अनुरोध
curl -X POST "https://api.threada.ai/api/v1/public/work-items/wi_123/actions" \
  -H "X-API-Key: <api-key>" \
  -H "Content-Type: application/json" \
  -d "{\"integration_id\":\"int_workflow\",\"idempotency_key\":\"act_456\",\"payload\":{\"type\":\"custom_http\",\"method\":\"POST\",\"url\":\"https://api.example.com/approvals\",\"body_json\":\"{\\\"approved\\\":true}\"}}"
प्रतिक्रिया
{
  "action": {
    "action_id": "act_456",
    "work_item_id": "wi_123",
    "action_type": "custom_http",
    "status": "completed"
  }
}

नमूना आर्टिफ़ैक्ट

Threada द्वारा उत्पन्न ऑब्जेक्ट्स के दृष्टांत उदाहरण, सिंथेटिक डेटा के साथ — वास्तविक ग्राहक या रिकॉर्ड नहीं। फ़ील्ड नाम Threada के API और ऑडिट स्कीमा का पालन करते हैं।

कार्यान्वयन मार्गदर्शन की आवश्यकता है?

रोलआउट और गवर्नेंस पैटर्न के लिए दस्तावेज़ों और तकनीकी अवलोकन का उपयोग करें।

तकनीकी टीम से संपर्क करें