Skip to main content
GET
Fetch

Authorizations

Authorization
string
header
required

Use a named environment API key. It starts with tr_dev_sk_, tr_prod_sk_, tr_stg_sk_, etc.

Create a named API key in the API Keys section of your Trigger.dev project dashboard. Choose the narrowest access preset that supports your integration.

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.

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

ok
boolean
required

Whether the run completed successfully.

id
string
required

The run ID.

output
string

The serialized output as a string (present when ok is true). Use outputType to determine how to parse it — for "application/json" use JSON.parse().

outputType
string

The content type of the serialized output, e.g. "application/json".

error
object

Error details (present when ok is false).

usage
object

Execution usage stats.

taskIdentifier
string

The task identifier.