Cancel Run

Cancel an in-flight run.

Idempotent: a run already in a terminal state (completed / failed / cancelled) is returned as-is. Once cancelled, the gateway refuses every subsequent chat_completions call from the worker — so the project cannot be billed further regardless of whether the worker subprocess notices the cancel itself.

The worker keeps running for at most one more bcode step (consuming no LLM tokens because CP 409s them) and then exits when bcode realizes the next tool call has no model behind it.

POST /runs/{run_id}/cancel

Cancel Run

JavaScript

const options = {method: 'POST', headers: {'X-Browser-Use-API-Key': '<api-key>'}};

fetch('https://api.browser-use.com/api/v4/runs/{run_id}/cancel', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

200

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "task": "<string>",
  "title": "<string>",
  "model": "<string>",
  "contextLimit": 123,
  "status": "queued",
  "result": "<string>",
  "error": "<string>",
  "sessionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "totalInputTokens": 123,
  "totalOutputTokens": 123,
  "totalCostUsd": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "modelParams": {},
  "output": null,
  "outputSchema": {},
  "attachedFileIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "judgement": {}
}

Authorizations

X-Browser-Use-API-Key · string · header · required

Path Parameters

run_id · string<uuid> · required

Response

200

application/json

Successful Response

id · string<uuid> · required

task · string · required

title · string | null · required

model · string · required

contextLimit · integer · required

status · enum<string> · required

Available options: queued, dispatching, running, completed, failed, cancelled

result · string | null · required

error · string | null · required

sessionId · string<uuid> · required

workspaceId · string<uuid> | null · required

totalInputTokens · integer · required

totalOutputTokens · integer · required

totalCostUsd · string · required

createdAt · string<date-time> · required

updatedAt · string<date-time> · required

modelParams · Modelparams · object | null

output · unknown

outputSchema · Outputschema · object | null

attachedFileIds · string<uuid>[] | null

judgement · Judgement · object | null