Create a bulk replay
Useruns.bulk.replay() to replay every run that matches a filter.
Your backend code
filter accepts the SDK run-list filter fields, excluding pagination fields such as limit, after, and before. This is the TypeScript SDK shape used by runs.list() (from, to, and period are top-level fields), not the nested filter[createdAt] query shape shown in the raw HTTP list-runs endpoint. Provide at least one filter field; use runIds when you want to target specific runs. Relative time filters such as period are resolved when the bulk action is created, so later batches process the same fixed time range.
Selects runs using the SDK run-list filter shape, excluding
limit, after, and before. In raw HTTP requests these fields are sent as JSON body properties, so time fields are top-level (from, to, period) instead of nested under createdAt.Selects specific run IDs. Provide either
filter or runIds, not both.A name for the bulk action.
Replays matching runs in a specific region. When omitted, each replay keeps the original run’s region. This option is only available for
runs.bulk.replay().Create a bulk cancel
Useruns.bulk.cancel() to cancel every run that matches a filter, or specific run IDs.
Your backend code
Retrieve progress
Useruns.bulk.retrieve() to read the current status and aggregate counts.
Your backend code
The bulk action ID, starting with
bulk_.The action being performed.
The current bulk action status.
Aggregate processing counts.
The date and time the bulk action was created.
The date and time the bulk action completed.
Poll for completion
Useruns.bulk.poll() to wait until the bulk action leaves the PENDING state.
Your backend code
Abort a bulk action
Useruns.bulk.abort() to stop future batches from being processed.
Your backend code
Each environment can only run a limited number of bulk replays at the same time. If you start a replay while too many are still in progress, the call fails and returns an error. Wait for an in-progress replay to finish or abort one before starting another. Bulk cancels are not subject to this limit.
List bulk actions
Useruns.bulk.list() to page through previous bulk actions in the current environment.
Your backend code
Your backend code

