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.

Per-test outcome counters on specs (results.stats) use the RecordedTestOutcome vocabulary—see components/schemas for how pending and skipped differ from failures.

Get run

get

https://api.currents.dev/v1https://api-staging.currents.dev/v1http://localhost:4000/v1

/runs/{runId}

Get a single run by ID with full details. Runs with many test files can produce a large JSON response. Include Accept-Encoding: gzip in your request when possible. Spec results.stats exposes pending, skipped, and failures separately; see RecordedTestOutcome in components/schemas and compare to Tests Explorer metrics mapping. For narrative context, see the Test result statuses section on the Test Explorer documentation page.

Authorizations

BearerAuth

AuthorizationstringRequired

API key authentication using Bearer token

Path parameters

runIdstringRequired

The run ID

Example: run_abc123

Responses

200

Successful response

application/json

statusstring · enumRequiredPossible values:

400

Invalid request parameters

application/json

401

Authentication failed

application/json

404

Resource not found

application/json

413

Payload Too Large - Response size exceeds limits. Use Accept-Encoding: gzip header.

application/json

get

/runs/{runId}

HTTPcURLJavaScriptPython

GET /v1/runs/{runId} HTTP/1.1
Host: api.currents.dev
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "status": "OK",
  "data": {
    "runId": "text",
    "projectId": "text",
    "createdAt": "2026-05-18T15:43:07.566Z",
    "durationMs": 1,
    "deletedAt": "2026-05-18T15:43:07.566Z",
    "tags": [
      "text"
    ],
    "previousRunId": "text",
    "timeout": {
      "isTimeout": true,
      "timeoutValueMs": 1
    },
    "cancellation": {
      "cancelledAt": "2026-05-18T15:43:07.566Z",
      "cancelledBy": "text",
      "reason": "text"
    },
    "groups": [
      {
        "groupId": "text",
        "platform": {
          "osName": "text",
          "osVersion": "text",
          "browserName": "text",
          "browserVersion": "text"
        },
        "tests": {
          "overall": 1,
          "passes": 1,
          "failures": 1,
          "pending": 1,
          "skipped": 1,
          "flaky": 1
        }
      }
    ],
    "meta": {
      "ciBuildId": "text",
      "pr": {
        "id": "text",
        "link": "text",
        "title": "text",
        "source": "text",
        "destination": "text"
      },
      "commit": {
        "sha": "text",
        "branch": "text",
        "authorName": "text",
        "authorEmail": "text",
        "message": "text",
        "remoteOrigin": "text"
      },
      "framework": {
        "name": "text",
        "version": "text"
      }
    },
    "specs": [
      {
        "spec": "text",
        "groupId": "text",
        "instanceId": "text",
        "claimedAt": "2026-05-18T15:43:07.566Z",
        "completedAt": "2026-05-18T15:43:07.566Z",
        "machineId": "text",
        "tags": [
          "text"
        ],
        "inactivityTimeoutMs": 1,
        "results": {
          "stats": {
            "suites": 1,
            "tests": 1,
            "passes": 1,
            "failures": 1,
            "pending": 1,
            "skipped": 1,
            "flaky": 1,
            "wallClockStartedAt": "2026-05-18T15:43:07.566Z",
            "wallClockEndedAt": "2026-05-18T15:43:07.566Z",
            "wallClockDuration": 1,
            "startedAt": "2026-05-18T15:43:07.566Z",
            "endedAt": "2026-05-18T15:43:07.566Z",
            "duration": 1
          },
          "exception": "text",
          "flaky": 1,
          "videoUrl": "text",
          "screenshots": [
            {
              "screenshotId": "text",
              "name": "text",
              "testId": "text",
              "testAttemptIndex": 1,
              "takenAt": "2026-05-18T15:43:07.566Z",
              "screenshotURL": "text"
            }
          ]
        }
      }
    ],
    "completionState": "complete",
    "status": "passed"
  }
}

Delete run

delete

https://api.currents.dev/v1https://api-staging.currents.dev/v1http://localhost:4000/v1

/runs/{runId}

Delete a run and all associated data

Authorizations

BearerAuth

AuthorizationstringRequired

API key authentication using Bearer token

Path parameters

runIdstringRequired

The run ID

Example: run_abc123

Responses

200

Run deleted successfully

application/json

statusstring · enumRequiredPossible values:

400

Invalid request parameters

application/json

401

Authentication failed

application/json

404

Resource not found

application/json

delete

/runs/{runId}

HTTPcURLJavaScriptPython

DELETE /v1/runs/{runId} HTTP/1.1
Host: api.currents.dev
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "status": "OK",
  "data": {
    "runId": "text"
  }
}

Find run

get

https://api.currents.dev/v1https://api-staging.currents.dev/v1http://localhost:4000/v1

/runs/find

Find a run by query parameters. Returns the most recent completed run matching the criteria. For runs with many test files, the response can be large. There is a 1MB response limit. It is strongly recommended to include Accept-Encoding: gzip header in your request to enable compression.

Authorizations

BearerAuth

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.

branchone ofOptional

Branch filter value: an exact branch name, or a trailing * for prefix match (e.g. release/*). Max 250 characters.

string · max: 250Optional

Exact branch name (must not contain * or spaces).

Pattern: ^[!-)+-~]+$

or

string · max: 250Optional

Prefix match: branch prefix followed by *.

Pattern: ^[!-)+-~]+\*$

tags[]string[]Optional

Filter by tags (can be specified multiple times using bracket notation, e.g., tags[]=value1&tags[]=value2)

Example: ["tag1","tag2"]

tag[]string[]OptionalDeprecated

Deprecated. Use tags[] instead. Run tags to filter by (can be specified multiple times using bracket notation, e.g., tag[]=tag1&tag[]=tag2)

Example: ["tag1","tag2"]

pwLastRunbooleanOptional

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

Responses

200

Successful response

application/json

statusstring · enumRequiredPossible values:

400

Invalid request parameters

application/json

401

Authentication failed

application/json

404

Resource not found

application/json

413

Payload Too Large - Response size exceeds limits. Use Accept-Encoding: gzip header.

application/json

get

/runs/find

HTTPcURLJavaScriptPython

GET /v1/runs/find?projectId=text HTTP/1.1
Host: api.currents.dev
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "status": "OK",
  "data": {
    "runId": "text",
    "projectId": "text",
    "createdAt": "2026-05-18T15:43:07.566Z",
    "durationMs": 1,
    "deletedAt": "2026-05-18T15:43:07.566Z",
    "tags": [
      "text"
    ],
    "previousRunId": "text",
    "timeout": {
      "isTimeout": true,
      "timeoutValueMs": 1
    },
    "cancellation": {
      "cancelledAt": "2026-05-18T15:43:07.566Z",
      "cancelledBy": "text",
      "reason": "text"
    },
    "groups": [
      {
        "groupId": "text",
        "platform": {
          "osName": "text",
          "osVersion": "text",
          "browserName": "text",
          "browserVersion": "text"
        },
        "tests": {
          "overall": 1,
          "passes": 1,
          "failures": 1,
          "pending": 1,
          "skipped": 1,
          "flaky": 1
        }
      }
    ],
    "meta": {
      "ciBuildId": "text",
      "pr": {
        "id": "text",
        "link": "text",
        "title": "text",
        "source": "text",
        "destination": "text"
      },
      "commit": {
        "sha": "text",
        "branch": "text",
        "authorName": "text",
        "authorEmail": "text",
        "message": "text",
        "remoteOrigin": "text"
      },
      "framework": {
        "name": "text",
        "version": "text"
      }
    },
    "specs": [
      {
        "spec": "text",
        "groupId": "text",
        "instanceId": "text",
        "claimedAt": "2026-05-18T15:43:07.566Z",
        "completedAt": "2026-05-18T15:43:07.566Z",
        "machineId": "text",
        "tags": [
          "text"
        ],
        "inactivityTimeoutMs": 1,
        "results": {
          "stats": {
            "suites": 1,
            "tests": 1,
            "passes": 1,
            "failures": 1,
            "pending": 1,
            "skipped": 1,
            "flaky": 1,
            "wallClockStartedAt": "2026-05-18T15:43:07.566Z",
            "wallClockEndedAt": "2026-05-18T15:43:07.566Z",
            "wallClockDuration": 1,
            "startedAt": "2026-05-18T15:43:07.566Z",
            "endedAt": "2026-05-18T15:43:07.566Z",
            "duration": 1
          },
          "exception": "text",
          "flaky": 1,
          "videoUrl": "text",
          "screenshots": [
            {
              "screenshotId": "text",
              "name": "text",
              "testId": "text",
              "testAttemptIndex": 1,
              "takenAt": "2026-05-18T15:43:07.566Z",
              "screenshotURL": "text"
            }
          ]
        }
      }
    ],
    "completionState": "complete",
    "status": "passed"
  }
}

Cancel run

put

https://api.currents.dev/v1https://api-staging.currents.dev/v1http://localhost:4000/v1

/runs/{runId}/cancel

Cancel a run in progress

Authorizations

BearerAuth

AuthorizationstringRequired

API key authentication using Bearer token

Path parameters

runIdstringRequired

The run ID

Example: run_abc123

Responses

200

Run cancelled successfully

application/json

statusstring · enumRequiredPossible values:

400

Invalid request parameters

application/json

401

Authentication failed

application/json

404

Resource not found

application/json

put

/runs/{runId}/cancel

HTTPcURLJavaScriptPython

PUT /v1/runs/{runId}/cancel HTTP/1.1
Host: api.currents.dev
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "status": "OK",
  "data": {
    "runId": "text",
    "cancelled": true,
    "cancelledAt": "2026-05-18T15:43:07.566Z"
  }
}

Reset run

put

https://api.currents.dev/v1https://api-staging.currents.dev/v1http://localhost:4000/v1

/runs/{runId}/reset

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

Authorizations

BearerAuth

AuthorizationstringRequired

API key authentication using Bearer token

Path parameters

runIdstringRequired

The run ID

Example: run_abc123

Body

application/json

machineIdstring[] · min: 1 · max: 63Required

Machine ID(s) to reset

isBatchedOr8nbooleanOptional

Whether to use batched orchestration

Responses

200

Run reset successfully

application/json

statusstring · enumRequiredPossible values:

dataobjectRequired

Reset operation result

400

Invalid request parameters

application/json

401

Authentication failed

application/json

404

Resource not found

application/json

put

/runs/{runId}/reset

HTTPcURLJavaScriptPython

PUT /v1/runs/{runId}/reset HTTP/1.1
Host: api.currents.dev
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 43

{
  "machineId": [
    "text"
  ],
  "isBatchedOr8n": true
}

{
  "status": "OK",
  "data": {}
}

Cancel run by GitHub CI

put

https://api.currents.dev/v1https://api-staging.currents.dev/v1http://localhost:4000/v1

/runs/cancel-ci/github

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

Authorizations

BearerAuth

AuthorizationstringRequired

API key authentication using Bearer token

Body

application/json

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

statusstring · enumRequiredPossible values:

400

Invalid request parameters

application/json

401

Authentication failed

application/json

404

Resource not found

application/json

put

/runs/cancel-ci/github

HTTPcURLJavaScriptPython

PUT /v1/runs/cancel-ci/github HTTP/1.1
Host: api.currents.dev
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 81

{
  "githubRunId": "text",
  "githubRunAttempt": 1,
  "projectId": "text",
  "ciBuildId": "text"
}

{
  "status": "OK",
  "data": {
    "runId": "text",
    "cancelled": true,
    "cancelledAt": "2026-05-18T15:43:07.566Z"
  }
}