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