Skip to main content
POST
/
api
/
v2
/
runs
/
{runId}
/
cancel
TypeScript
import { runs } from "@trigger.dev/sdk";

await runs.cancel("run_1234");
{
  "id": "run_1234"
}

Authorizations

​
Authorization
string
header
required

Use your project-specific Secret API key. Will start with tr_dev_, tr_prod, tr_stg, etc.

You can find your Secret API key in the API Keys section of your Trigger.dev project dashboard.

Our TypeScript SDK will default to using the value of the TRIGGER_SECRET_KEY environment variable if it is set. If you are using the SDK in a different environment, you can set the key using the configure function.

import { configure } from "@trigger.dev/sdk";

configure({ accessToken: "tr_dev_1234" });

Path Parameters

​
runId
string
required

The ID of an run, starts with run_. The run ID will be returned when you trigger a run on a task.

Response

Successful request

​
id
string

The ID of the run that was canceled.

Example:

"run_1234"

⌘I