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

# POST /v1/runs/{id}/cancel

Cancel a running or waiting run

` POST /v1/runs/{id}/cancel `

Cancel a running or waiting run

## Parameters

### ` id ` (path, required)

Run ID

- ` value `: type ` string `

## Responses

### ` 200 ` — OK

Content type: ` application/json `

- ` value `: type ` object `

  - ` code `: type ` integer `

    - example: ` 200 `

  - ` data `: type ` object `

    - ` executionState `: type ` object `

    - ` finishedAt `: type ` string `

    - ` id `: type ` string `

    - ` isDustTest `: type ` boolean `

    - ` isSimulation `: type ` boolean `

    - ` organizationId `: type ` string `

    - ` propValues `: type ` object `

    - ` simulationForks `: type ` array `

      - ` array item `: type ` object `

        - ` chainId `: type ` integer `

        - ` forkId `: type ` string `

        - ` rpcUrl `: type ` string `

    - ` simulationMode `: type ` string `

    - ` sourceRunId `: type ` string `

    - ` startedAt `: type ` string `

    - ` status `: type ` string `

      - enum: ` ["running","waiting","success","partial","failure","cancelled"] `

    - ` summary `: type ` string `

    - ` totalCu `: type ` number ` — Not a column; populated by service

    - ` triggerNodeId `: type ` string `

    - ` triggerSource `: type ` string `

    - ` triggeredBy `: type ` string `

    - ` workflowDefinition `: type ` object ` — Definition is the inline workflow graph to analyze. Same shape as a saved workflow's definition. Unlike the ephemeral-run endpoint there is no trigger restriction — analysis is read-only and method-agnostic.

      - Required fields: ` nodes `

      - ` blockExpansions `: type ` object ` — Set on run snapshots only (not workflow DB)

      - ` inputSchema `: type ` array `

        - ` array item `: type ` object `

          - ` description `: type ` string `

          - ` key `: type ` string `

          - ` required `: type ` boolean `

          - ` type `: type ` string ` — "string", "number", "boolean", "object", "array"

      - ` nodes `: type ` object `

      - ` sensitivePropKeys `: type ` array ` — Legacy: kept for old runs; no longer populated for new workflows

        - ` array item `: type ` string `

      - ` triggerNodeIds `: type ` array ` — TriggerNodeIDs lists the node IDs that are trigger (root) nodes. Every workflow declares this — single-trigger workflows ship ["root"] (the legacy node id), multi-trigger workflows list every trigger node id. Treating single-trigger as a forest-of-1 removes the two-path branching throughout the BE + FE; older rows without the field are backfilled by migration 000282 and the field-missing path stays as a read-side safety net (see FindTriggerNodeIDs) but is no longer exercised by saves.  "root" is also a runtime alias for "the trigger that fired this run" — {{root.X}} variable references resolve to the firing trigger regardless of which trigger fired. Don't repurpose the literal "root" as a trigger id on a multi-trigger workflow.

        - ` array item `: type ` string `

      - ` variableDefs `: type ` array ` — VariableDefs is a snapshot of the workflow's declared variables at run creation time. The canonical source lives on the workflows row (Workflow.VariableDefs column). Snapshotted into the run definition so the worker can resolve {{$vars.x}} lookups and route variable-action writes to the right scope without an extra DB round trip.

        - ` array item `: type ` object `

          - ` default `: type ` unknown `

          - ` description `: type ` string `

          - ` lifetime `: type ` string `

            - enum: ` ["persist","reset"] `

          - ` name `: type ` string `

          - ` type `: type ` string `

            - enum: ` ["number","text","boolean","list","object"] `

    - ` workflowId `: type ` string `

    - ` workflowOwnerUserId `: type ` string `

    - ` workflowVersion `: type ` integer `

  - ` message `: type ` string `

    - example: ` "success" `

  - ` requestId `: type ` string `

    - example: ` "abc-123" `

### ` 404 ` — Not Found

Content type: ` application/json `

- ` value `: type ` object `

  - ` code `: type ` integer `

  - ` details `: type ` array `

    - ` array item `: type ` unknown `

  - ` message `: type ` string `

  - ` requestId `: type ` string `

### ` 409 ` — Conflict

Content type: ` application/json `

- ` value `: type ` object `

  - ` code `: type ` integer `

  - ` details `: type ` array `

    - ` array item `: type ` unknown `

  - ` message `: type ` string `

  - ` requestId `: type ` string `

## Request examples

### cURL

```curl
curl -X POST 'https://api.example.com/v1/runs/string/cancel' \
  -H 'Authorization: Bearer YOUR_API_TOKEN'
```

### JavaScript

```javascript
const response = await fetch('https://api.example.com/v1/runs/string/cancel', {
  method: 'POST',
  headers: {
      "Authorization": "Bearer YOUR_API_TOKEN"
  }
});

const data = await response.json();
console.log(data);
```

### Python

```python
import requests

headers = {
    'Authorization': 'Bearer YOUR_API_TOKEN'
}

response = requests.post('https://api.example.com/v1/runs/string/cancel', headers=headers)
print(response.json())
```

### Go

```go
package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("POST", "https://api.example.com/v1/runs/string/cancel", nil)
	req.Header.Set("Authorization", "Bearer YOUR_API_TOKEN")

	resp, _ := http.DefaultClient.Do(req)
	defer resp.Body.Close()
	result, _ := io.ReadAll(resp.Body)
	fmt.Println(string(result))
}
```