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/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"
}