> ## Documentation Index
> Fetch the complete documentation index at: https://docs.bland.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Cancel Check Run

> Cancel a pending or running check run.

### Overview

Marks a `PENDING` or `RUNNING` run `CANCELLED` and stops its scoring work. A cancelled run never produces a final verdict, and cancelling frees the environment so a new run can be started with [Start Check Run](https://docs.bland.ai/api-v2/post/agents-id-environments-env-check-runs.md). Returns `409 CONFLICT` when the run is already `PASSED`, `FAILED`, `ERROR`, or `CANCELLED`. Cancelling never changes an environment pointer.

Requires an admin, owner, operator, or prompter role. This endpoint takes no body.

### Headers

**authorization** `string` *required*

Your API key for authentication.

### Path Parameters

**agent\_id** `string` *required*

The agent's unique identifier.

**run\_id** `string` *required*

The check run's unique identifier.

### Response

**data** `object`

The cancelled run, with `status` set to `CANCELLED` and `completed_at` set to the cancellation time.

**check run object**

**id** `string`

Unique identifier for the check run.

**agent\_id** `string`

The agent the run belongs to.

**env\_type** `string`

The environment whose checks were run: `staging` or `production`.

**agent\_version\_id** `string`

The candidate version the run was scoring.

**semver** `string | null`

The candidate's published version number, or `null` if it has never been published.

**version\_name** `string | null`

The candidate's saved name, or `null` if it has none.

**status** `string`

Always `CANCELLED` on success.

**judge\_names** `array`

Display names of the judges frozen into the run when it started.

**scenario\_count** `integer`

Number of scenarios the run was driving conversations from.

**simulations\_count** `integer`

Conversations generated per scenario.

**overall\_passed** `boolean | null`

`null` for a cancelled run.

**verdicts** `array | null`

`null` for a cancelled run. See [Get Check Run](https://docs.bland.ai/api-v2/get/agents-id-check-runs-run-id.md) for the verdict object.

**simulation\_set\_id** `string | null`

ID of the generated conversation set, if generation had started.

**eval\_run\_id** `string | null`

ID of the scoring run, if scoring had started.

**error\_message** `string | null`

`null` unless the run had already hit an error.

**triggered\_by** `string | null`

ID of the user who started the run, or `null` when started with an org-level key.

**created\_at** `string`

ISO 8601 timestamp the run was created.

**started\_at** `string | null`

When scoring began, or `null` if the run was cancelled while `PENDING`.

**completed\_at** `string | null`

The cancellation time.

**errors** `null | array`

`null` on success, or a list of error objects if the request failed.

```json Response theme={null}
{
  "data": {
    "id": "9eab4005-81c7-46c4-b4af-cd219844dd53",
    "agent_id": "358f36b8-91ea-4c19-90ed-f1ebc9f861c9",
    "env_type": "staging",
    "agent_version_id": "a26b7ffd-7f60-4f62-9592-861d40fdac3c",
    "semver": null,
    "version_name": "Trim hold music prompt",
    "status": "CANCELLED",
    "judge_names": ["Resolution quality"],
    "scenario_count": 3,
    "simulations_count": 5,
    "overall_passed": null,
    "verdicts": null,
    "simulation_set_id": "9d76db16-4da7-450f-9c78-f72539731e1e",
    "eval_run_id": null,
    "error_message": null,
    "triggered_by": "1473e1e7-c185-4c56-85fb-dab8863394b3",
    "created_at": "2026-09-10T19:22:07.530Z",
    "started_at": "2026-09-10T19:22:10.088Z",
    "completed_at": "2026-09-10T19:25:41.962Z"
  },
  "errors": null
}
```

```json Not Cancellable theme={null}
{
  "data": null,
  "errors": [
    {
      "error": "CONFLICT",
      "message": "Check run is not in a cancellable state"
    }
  ]
}
```

```json Not Found theme={null}
{
  "data": null,
  "errors": [
    {
      "error": "NOT_FOUND",
      "message": "Check run not found"
    }
  ]
}
```

***

Docs for agents: [llms.txt](https://docs.bland.ai/llms.txt)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.