コンテンツへスキップ
Runs

分析ランをキャンセル

POST/api/v1alpha1/runs/{run_id}/cancel

保留中または実行中の分析ラン(Run)に停止を要求します。

  • アクセス: alphaを有効にしたAPI keyとRUN_WORKFLOWS権限。
  • 非同期: キャンセルは要求であり、保証ではありません。
  • 再試行: 任意のIdempotency-Keyにより、キャンセルの再送を安全に扱えます。

runが最終状態になるまでGET /api/v1alpha1/runs/{run_id}のpollを続けてください。

認証

apiKey
認証Bearer <token>

場所: header

パスパラメーター

run_id*string

分析ラン(Run)の識別子です。run作成時に返ります。

ヘッダーパラメーター

Idempotency-Key?string

このPOSTを安全にretryするための任意のkeyです。keyは24時間保持され、request payloadと具体的なpath parameterと比較されます。

長さlength <= 255

レスポンスボディ

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X POST "https://example.com/api/v1alpha1/runs/run_0190b5d4-7e1f-7a2b-9c3d-1234567890ab/cancel" \  -H "Authorization: Bearer $DEEPFRAME_API_KEY"
{  "created_at": "2026-08-08T10:00:00.000Z",  "id": "run_0190b5d4-7e1f-7a2b-9c3d-1234567890ab",  "kind": "workflow",  "status": "queued",  "updated_at": "2026-08-08T10:07:30.000Z",  "workflow": {    "case_id": "case_0190b5d4-7e1f-7a2b-9c3d-1234567890ab",    "error": {      "code": "budget_exhausted",      "detail": "",      "next_action": "",      "title": ""    },    "error_message": "",    "provenance": {      "execution_profile": "premium-analysis@1",      "provenance_ref": "prov_0190b5d4-analysis",      "request_id": "0190b5d4-7e1f-7a2b-9c3d-1234567890ab",      "usage": {        "cached_input_tokens": 0,        "input_tokens": 0,        "media_seconds": 0,        "output_tokens": 0,        "provider_returned_cost": "",        "total_tokens": 0      }    },    "reason_code": "",    "report_id": "rep_0190b5d4-7e1f-7a2b-9c3d-1234567890ab",    "rule_set_version_id": "snap_7ef3a4b2c1d0",    "rulebook_id": "rb_0190b5d4-7e1f-7a2b-9c3d-1234567890ab",    "source_snapshot": {      "source_ids": [        "vid_0190b5d4-7e1f-7a2b-9c3d-1234567890ab"      ]    },    "summary": "Workflow execution is evaluating indexed evidence.",    "workflow_id": "wf_0190b5d4-7e1f-7a2b-9c3d-1234567890ab"  }}