مواد پر جائیں

API ریفرنس

WorkItem آپریشنز، فیصلہ-مرحلہ کنٹرول، انٹیگریشن عمل درآمد اور ٹیلیمیٹری برآمد کے لیے ریفرنس۔

یہ APIs واضح پالیسی اور ٹیننٹ کے دائرے کے ساتھ قابلِ پیشگوئی آٹومیشن رویے کے لیے ڈیزائن کیے گئے ہیں۔

بنیادی اینڈ پوائنٹ

توثیق شدہ درخواستوں کے لیے اپنا کنفیگر کردہ عوامی API اینڈ پوائنٹ استعمال کریں۔

https://api.threada.ai

توثیق اور سیاق

  • API رسائی کے لیے محدود کردہ اسناد استعمال کریں
  • جہاں ضروری ہو وہاں ٹیننٹ اور رول کا سیاق شامل کریں
  • درست سیاق کے بغیر درخواستیں ناکام ہو کر بند ہو جاتی ہیں

عام scopes

  • workitems:read اور workitems:write
  • پالیسی اور فیصلوں کی اپ ڈیٹ کے لیے workflow:manage
  • زیرِ ضابطہ عمل درآمد کے لیے actions:execute
  • برآمدات اور تجزیے کے لیے telemetry:read

صفحہ بندی اور فلٹرنگ

  • List اینڈ پوائنٹس cursor- یا token-بنیاد صفحہ بندی کی سپورٹ کرتے ہیں
  • چینل، ورک فلو، اسٹیٹس، پالیسی ورژن اور وقت کی حد کے مطابق فلٹر کریں
  • بڑی ٹیلیمیٹری برآمدات کے لیے محدود وقفوں کو ترجیح دیں

ایرر ماڈل

  • تصدیق، اجازت، پالیسی اور عمل درآمد کی ناکامیوں کے لیے ٹائپ شدہ ایرر کی اقسام
  • ریزن کوڈز آپریٹر ٹولنگ میں متعین رویے کی سپورٹ کرتے ہیں
  • کراس-سروس چھان بین کے لیے کوریلیشن IDs واپس کی جاتی ہیں

مثال درخواستیں

انٹیک پے لوڈ سے ایک WorkItem بنائیں

ورک فلو پروسیسنگ کے لیے ایک canonical ورک ریکارڈ بنائیں۔ جہاں ضروری ہو وہاں انٹیک چینل کے لیے چینل شناخت کنندہ شامل کریں۔

درخواست 
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 اور آڈٹ schemas کی پیروی کرتے ہیں۔

عمل درآمد کی رہنمائی درکار ہے؟

رول آؤٹ اور گورننس کے طریقوں کے لیے دستاویزات اور تکنیکی جائزہ استعمال کریں۔

تکنیکی ٹیم سے رابطہ کریں