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/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 および監査スキーマに従っています。