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

await runs.retrieve("run_1234");
{
  "id": "<string>",
  "status": "PENDING",
  "taskIdentifier": "<string>",
  "idempotencyKey": "<string>",
  "version": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "attempts": [
    {
      "id": "<string>",
      "status": "PENDING",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "startedAt": "2023-11-07T05:31:56Z",
      "completedAt": "2023-11-07T05:31:56Z"
    }
  ]
}

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

run_id
string
required

The ID of an existing run. When you trigger a run you will get an id in the response.

Response

200 - application/json
id
string
required
status
enum<string>
required
Available options:
PENDING,
EXECUTING,
PAUSED,
COMPLETED,
FAILED,
CANCELED
taskIdentifier
string
required
idempotencyKey
string
version
string
createdAt
string
required
updatedAt
string
required
attempts
object[]
required