cancel_run

Cancel a pending or running model execution. Passing the first planned child run_id (the group’s ID) cancels every pending or running child in that parameter-matrix group. This mutation returns data only and does not open an MCP App. Pass workspace_id to cancel a run in a workspace other than your current one (requires an active membership and a grant on the model there; OAuth/JWT sessions only) — the run must belong to that workspace and model.

Parameters

Name	Type	Required	Default	Description
model_name	Annotated[str, Field(description='Name of the model the run belongs to.')]	Yes	—
run_id	Annotated[str, Field(description='Full UUID of the run to cancel. Must be in pending or running state.')]	Yes	—
workspace_id	`Annotated[str	None, Field(description=WORKSPACE_ID_FIELD_DESCRIPTION)]`	No	None

Returns

Returns a structured object. Top-level fields:

• run_id (string)
• status (string)
• model_name (string)
• message (string)

See the response example below for the full payload shape.

Example

Tool Call

{
  "name": "cancel_run",
  "arguments": {
    "model_name": "forecasts",
    "run_id": "66666666-6666-6666-6666-666666666666"
  }
}

Response

{
  "run_id": "66666666-6666-6666-6666-666666666666",
  "status": "cancelled",
  "model_name": "forecasts",
  "message": "Run cancelled successfully."
}

Notes

• Module: Execution
• Requires an authenticated Bridge Town session (OAuth) or an API token.