Retrieve run
Retrieve information about a run, including its status, payload, output, and attempts. If you authenticate with a Public API key, we will omit the payload and output fields for security reasons.
Authorizations
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
The ID of an run, starts with run_. The run ID will be returned when you trigger a run on a task.
Response
The unique ID of the run, prefixed with run_
The status of the run
DELAYED, WAITING_FOR_DEPLOY, QUEUED, EXECUTING, REATTEMPTING, FROZEN, COMPLETED, CANCELED, FAILED, CRASHED, INTERRUPTED, SYSTEM_FAILURE The identifier of the task that was run
The version of the worker that executed the run
The idempotency key used to prevent creating duplicate runs, if provided
Whether the run is a test run or not
The time the run started
The time the run finished
If the run was triggered with a delay, this will be the time the run will be enqueued to execute
The time-to-live for this run. If the run is not executed within this time, it will be removed from the queue and never execute. You can use a string in this format: 1h, 1m, 1h42m or a number of seconds (min. 1).
If the run had a TTL and that time has passed, when the run "expired".
Tags can be attached to a run to make it easy to find runs (in the dashboard or using SDK functions like runs.list)
The metadata of the run. See Metadata for more information.
The compute cost of the run (so far) in cents. This cost does not apply to DEV runs.
The invocation cost of the run in cents. This cost does not apply to DEV runs.
The duration of compute (so far) in milliseconds. This does not include waits.
The depth of the run in the task run hierarchy. The root run has a depth of 0.
The ID of the batch that this run belongs to
The name of the function that triggered the run
trigger, triggerAndWait, batchTrigger, batchTriggerAndWait The payload that was sent to the task. Will be omitted if the request was made with a Public API key
The presigned URL to download the payload. Will only be included if the payload is too large to be included in the response. Expires in 5 minutes.
The output of the run. Will be omitted if the request was made with a Public API key
The presigned URL to download the output. Will only be included if the output is too large to be included in the response. Expires in 5 minutes.
The schedule that triggered the run. Will be omitted if the run was not triggered by a schedule
Was this page helpful?