メインコンテンツへスキップ

エンドポイント

POST http://localhost:8080/api/v1/tasks/{id}/pause

説明

次のワークフローチェックポイントで実行中のタスクを一時停止します。現在のアクティビティ(LLM呼び出し、ツールなど)は完了することが許可され、その後、ワークフローは再開またはキャンセルされるまでブロックされます。 進行状況を失うことなく、長時間実行される研究や監視ワークフローを一時的に停止したい場合に使用します。

認証

必要: はい ヘッダーにAPIキーを含めてください:
X-API-Key: sk_test_123456

リクエスト

ヘッダー

ヘッダー必要説明
X-API-KeyはいAPI認証キー
Content-Typeいいえボディがある場合はapplication/json
traceparentいいえW3Cトレースコンテキスト

パスパラメータ

パラメータタイプ必要説明
idstringはいタスクID(TemporalワークフローID)

ボディパラメータ

パラメータタイプ必要説明
reasonstringいいえ一時停止の理由のオプションノート

リクエストボディの例

{
  "reason": "ユーザーが中間結果をレビューしている間に一時停止"
}

レスポンス

202 Accepted

{
  "success": true,
  "message": "一時停止信号が送信されました",
  "task_id": "task-123"
}

404 Not Found

{ "error": "タスクが見つかりません" }

409 Failed Precondition

無効な状態でタスクを一時停止できません:
{ "error": "完了したタスクを一時停止できません" }
{ "error": "失敗したタスクを一時停止できません" }
{ "error": "キャンセルされたタスクを一時停止できません" }
{ "error": "タイムアウトしたタスクを一時停止できません" }
{ "error": "タスクはすでに一時停止しています" }

401 / 403

{ "error": "認証されていません" }
または
{ "error": "禁止されています" }

注意事項

  • 一時停止は明確に定義されたチェックポイント(例:pre_executionpre_completion)で効果を発揮し、進行中のアクティビティを中断しません。
  • 一時停止中、SSEストリームはworkflow.pausingおよびworkflow.pausedイベントをcheckpointフィールドと共に発信します。
  • 所有権とテナンシーが強制されます:ユーザーは自分のタスクのみを一時停止できます。