cancel_run
Cancel a pending or running model execution. Returns: run_id (str) — cancelled run UUID; status (str) — always ‘cancelled’; project_name (str) — project name; message (str) — confirmation message.
Parameters
Section titled “Parameters”| Name | Type | Required | Default | Description |
|---|---|---|---|---|
project_name | str | Yes | — | |
run_id | str | Yes | — |
Returns
Section titled “Returns”Returns a structured object. Top-level fields:
run_id(string)status(string)project_name(string)message(string)
See the response example below for the full payload shape.
Example
Section titled “Example”Tool Call
Section titled “Tool Call”{ "name": "cancel_run", "arguments": { "project_name": "forecasts", "run_id": "66666666-6666-6666-6666-666666666666" }}Response
Section titled “Response”{ "run_id": "66666666-6666-6666-6666-666666666666", "status": "cancelled", "project_name": "forecasts", "message": "Run cancelled successfully."}- Module:
Execution - Requires authentication via API token or Auth0 JWT.