跳到内容

API 参考

WorkItem 操作、决策步骤控制、集成执行和遥测导出的参考。

这些 API 专为具有明确策略和租户范围限定的可预测自动化行为而设计。

基础端点

使用您配置的公共 API 端点来发起经过身份验证的请求。

https://api.threada.ai

身份验证与上下文

  • 使用限定范围的凭据进行 API 访问
  • 在需要时附带租户和角色上下文
  • 缺少有效上下文的请求会默认拒绝(fail-closed)

典型范围

  • 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 与审计模式。

需要实施指导吗?

查阅文档与技术概览,了解推出和治理模式。

联系技术团队