PUT
/
api
/
v1
/
runs
/
{runId}
/
metadata

Authorizations

Authorization
string
headerrequired

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/v3";

configure({ secretKey: "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
metadata
object

The new metadata to set on the run.

Response

200 - application/json
metadata
object

The updated metadata of the run.