エンドポイント
説明
次のワークフローチェックポイントで実行中のタスクを一時停止します。現在のアクティビティ(LLM呼び出し、ツールなど)は完了することが許可され、その後、ワークフローは再開またはキャンセルされるまでブロックされます。 進行状況を失うことなく、長時間実行される研究や監視ワークフローを一時的に停止したい場合に使用します。認証
必要: はい ヘッダーにAPIキーを含めてください:リクエスト
ヘッダー
| ヘッダー | 必要 | 説明 |
|---|---|---|
X-API-Key | はい | API認証キー |
Content-Type | いいえ | ボディがある場合はapplication/json |
traceparent | いいえ | W3Cトレースコンテキスト |
パスパラメータ
| パラメータ | タイプ | 必要 | 説明 |
|---|---|---|---|
id | string | はい | タスクID(TemporalワークフローID) |
ボディパラメータ
| パラメータ | タイプ | 必要 | 説明 |
|---|---|---|---|
reason | string | いいえ | 一時停止の理由のオプションノート |
リクエストボディの例
レスポンス
202 Accepted
404 Not Found
409 Failed Precondition
無効な状態でタスクを一時停止できません:401 / 403
注意事項
- 一時停止は明確に定義されたチェックポイント(例:pre_execution、pre_completion)で効果を発揮し、進行中のアクティビティを中断しません。
- 一時停止中、SSEストリームは
workflow.pausingおよびworkflow.pausedイベントをcheckpointフィールドと共に発信します。 - 所有権とテナンシーが強制されます:ユーザーは自分のタスクのみを一時停止できます。