Skip to main content
GET
Fetch

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.

Path Parameters

batchId
string
required

The ID of the batch, starts with batch_.

Response

Successful request

id
string

The batch ID.

status
enum<string>

The current status of the batch.

Available options:
PENDING,
PROCESSING,
COMPLETED,
PARTIAL_FAILED,
ABORTED
idempotencyKey
string | null

The idempotency key provided when triggering, if any.

createdAt
string<date-time>
updatedAt
string<date-time>
runCount
integer

The total number of runs in the batch.

runs
string[]

Array of run IDs in the batch.

successfulRunCount
integer | null

Number of successful runs (populated after completion).

failedRunCount
integer | null

Number of failed runs (populated after completion).

errors
object[] | null

Error details for failed items (present for PARTIAL_FAILED batches).