Screenshots

You can access all screenshots taken during a test run via API. This is handy for running Snapshot comparisons with a screenshot baseline. If you set the query parameter detailed the endpoint will return more data per screenshot.

Retrieve Screenshots from a Test Run

Returns an array of screenshot URLs or structured JSON objects taken during the specific run.

get

/test_suites/{suiteId}/runs/{runId}/screenshots

Path parameters

suiteIdstringrequired

The ID of the test suite.

Example: suite123

runIdstringrequired

The ID of the test run.

Example: run456

Query parameters

detailedboolean · default: true

If true, provides a structured response with detailed JSON objects per screenshot.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/test_suites/{suiteId}/runs/{runId}/screenshots'

200

200

[
  "https://example.com/screenshots/screenshot123.png"
]

List of screenshots retrieved successfully.