---
title: "Cancel a playbook run"
method: POST
path: "/playbooks/{id}/runs/{runId}/cancel"
tags: ["Playbooks"]
---

# Cancel a playbook run

`POST /playbooks/{id}/runs/{runId}/cancel`

## Request

- Base URL: `https://next.frase.io/api/v1`
- URL: `https://next.frase.io/api/v1/playbooks/{id}/runs/{runId}/cancel`
- Auth: API key in header `X-API-KEY`

Cancel a run that is still pending, running, or paused. A run that has already reached a terminal state, or finishes between the check and the write, returns 409 `invalid_state`.

## Path parameters

- `id` string, uuid, required
- `runId` string, uuid, required

## Response `200`

Run cancelled

- object
  - `data` object
    - `cancelled` boolean
    - `run_id` string, uuid
  - `request_id` string

## Other responses

- `400`: Validation failed
- `401`: Authentication failed
- `404`: Resource not found
- `409`: The run is no longer in a cancellable state
- `429`: Rate limited, or the org's monthly brief limit blocked minting the refreshed brief (only the FIRST supersession of a brief is billing-exempt; repeats meter normally)

---

[API](https://skmtc.dev/frase/apis/frase-api.md) · [All operations](https://skmtc.dev/frase/apis/frase-api/llms.txt) · [OpenAPI document](https://skmtc.dev/frase/apis/frase-api/revisions/7fb75d89f7a4?raw)
