跳至內容

API 參考

WorkItem 操作、決策步驟控制、整合執行同遙測匯出嘅參考。

呢啲 API 專為具有明確政策同租戶範圍嘅可預測自動化行為而設計。

基本 endpoint

使用你設定嘅公共 API endpoint 嚟進行經過身份驗證嘅請求。

https://api.threada.ai

身份驗證同上下文

  • 使用範圍限定嘅憑證進行 API 存取
  • 按需要包含租戶同角色上下文
  • 缺乏有效上下文嘅請求會以失敗封閉處理

典型範圍

  • workitems:read 同 workitems:write
  • workflow:manage 用於政策同決策更新
  • actions:execute 用於受管治執行
  • telemetry:read 用於匯出同分析

分頁同過濾

  • 列表 endpoint 支援基於游標或 token 嘅分頁
  • 按渠道、工作流程、狀態、政策版本同時間範圍過濾
  • 大型遙測匯出宜採用有界窗口

錯誤模型

  • 針對驗證、授權、政策同執行失敗嘅定型錯誤類別
  • 原因程式碼支援操作員工具入面嘅確定性處理
  • 返回相關 ID 以進行跨服務調查

請求示例

由接收 payload 建立一個 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 同稽核 schema。

需要實施指導？

使用文件同技術概述嚟了解推出同管治模式。

聯絡技術團隊