Add tags to a run

Adds one or more tags to a run. Runs can have a maximum of 10 tags. Duplicate tags are ignored.

POST /api/v1/runs/{runId}/tags

TypeScript

SDK

import { runs } from "@trigger.dev/sdk"; await runs.addTags("run_1234", ["tag-1", "tag-2"]);

200

{
  "message": "Successfully set 2 new tags."
}

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.

Body

application/json

tags · string string[] · required

One or more tags to attach to a run. Runs can have a maximum of 10 tags.

Maximum string length: 128

Example:

"user_123456"

Response

200

application/json

Successful request

message · string

Example:

"Successfully set 2 new tags."