---
title: "Cancel Run"
method: POST
path: "/api/runs/{run_id}/cancel"
tags: ["runs"]
---

# Cancel Run

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

## Request

- Base URL: `https://api.retirementlab.app` (the document declares no server; this is the origin it was published from)
- URL: `https://api.retirementlab.app/api/runs/{run_id}/cancel`
- Auth: HTTP bearer

Cancel a queued or running run owned by the caller.

## Path parameters

- `run_id` integer, required

## Request body

- CancelRunRequest
  - `idempotency_key` string

## Response `200`

Successful Response

- CancelRunResponse
  - `run_id` integer, required
  - `status` 'cancelled', required
  - `idempotency_key` string
  - `assumptions_version` string
  - `assumptions_version_state` 'declared' | 'legacy_unverified'

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/retirementlab/apis/income-simulator-api.md) · [All operations](https://skmtc.dev/retirementlab/apis/income-simulator-api/llms.txt) · [OpenAPI document](https://skmtc.dev/retirementlab/apis/income-simulator-api/revisions/b0f00a0333fd?raw)