Runs

Query and manage test runs.

A run represents a single execution of your test suite. Runs contain spec files which are executed across multiple instances. You can query run details, cancel runs, reset failed specs, and delete runs.

Get run

get
/runs/{runId}

Get a single run by ID with full details

Authorizations
AuthorizationstringRequired

API key authentication using Bearer token

Path parameters
runIdstringRequired

The run ID

Example: run_abc123
Responses
200

Successful response

application/json
get
/runs/{runId}

Delete run

delete
/runs/{runId}

Delete a run and all associated data

Authorizations
AuthorizationstringRequired

API key authentication using Bearer token

Path parameters
runIdstringRequired

The run ID

Example: run_abc123
Responses
200

Run deleted successfully

application/json
delete
/runs/{runId}

Find run

get
/runs/find

Find a run by query parameters. Returns the most recent completed run matching the criteria.

Authorizations
AuthorizationstringRequired

API key authentication using Bearer token

Query parameters
projectIdstringRequired

The project ID

Example: proj_abc123
ciBuildIdstringOptional

The CI build ID. If provided, returns the run with this exact ciBuildId.

branchstringOptional

Git branch name. Used when ciBuildId is not provided.

tagstring[]Optional

Run tags to filter by (can be specified multiple times)

pwLastRunbooleanOptional

If true, includes information about failed tests from the last run (Playwright only)

Responses
200

Successful response

application/json
get
/runs/find

Cancel run

put
/runs/{runId}/cancel

Cancel a run in progress

Authorizations
AuthorizationstringRequired

API key authentication using Bearer token

Path parameters
runIdstringRequired

The run ID

Example: run_abc123
Responses
200

Run cancelled successfully

application/json
put
/runs/{runId}/cancel

Reset run

put
/runs/{runId}/reset

Reset failed spec files in a run to allow re-execution. Requires specifying machineId(s) to reset.

Authorizations
AuthorizationstringRequired

API key authentication using Bearer token

Path parameters
runIdstringRequired

The run ID

Example: run_abc123
Body
machineIdstring[] · min: 1 · max: 63Required

Machine ID(s) to reset

isBatchedOr8nbooleanOptional

Whether to use batched orchestration

Responses
200

Run reset successfully

application/json
put
/runs/{runId}/reset

Cancel run by GitHub CI

put
/runs/cancel-ci/github

Cancel a run by GitHub Actions workflow run ID and attempt number

Authorizations
AuthorizationstringRequired

API key authentication using Bearer token

Body
githubRunIdstringRequired

GitHub Actions workflow run ID

githubRunAttemptintegerRequired

GitHub Actions workflow run attempt number

projectIdstringOptional

Optional project ID to scope the cancellation

ciBuildIdstringOptional

Optional CI build ID to scope the cancellation

Responses
200

Run cancelled successfully

application/json
put
/runs/cancel-ci/github

Last updated

Was this helpful?