ワークフロータスクを停止

実行中のワークフロータスクを停止します。streaming モードでのみサポートされます。

POST /workflows/tasks/{task_id}/stop

Error

A valid request URL is required to generate request examples

200

success

{
  "result": "success"
}

承認

Authorization · string · header · 必須

API Key 認証です。すべての API リクエストにおいて、Authorization HTTP ヘッダーに Bearer プレフィックスを付けた API Key を含めてください。例：Authorization: Bearer {API_KEY}。API Key はサーバーサイドに保存し、クライアントサイドで共有・保存しないことを強く推奨します。API Key の漏洩は深刻な結果につながる可能性があります。

パスパラメータ

task_id · string · 必須

タスク ID です。ワークフローを実行 API のストリーミングチャンクレスポンスから取得できます。

ボディ

application/json

user · string · 必須

ユーザー識別子です。ワークフローを実行 リクエストで渡したユーザーと一致する必要があります。

レスポンス

200

application/json

操作が成功しました。

result · enum<string>

操作結果です。

利用可能なオプション: success