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

get

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

Path parameters

suiteIdstringRequired

The ID of the test suite.

Example: suite123

runIdstringRequired

The ID of the test run.

Example: run456

Query parameters

detailedbooleanOptional

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

Default: true

Responses

200

List of screenshots retrieved successfully.

application/json

Responseone of

string · uri[]Optional

List of screenshot URLs.

Example: https://example.com/screenshots/screenshot123.png

or

get

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

HTTPcURLJavaScriptPython

GET /test_suites/{suiteId}/runs/{runId}/screenshots HTTP/1.1
Accept: */*

200

List of screenshots retrieved successfully.

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