Visual Regression

Visual regression reference screenshots

List visual regression reference screenshots

get

Returns a list of visual regression reference screenshots.

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Query parameters

pageintegerOptional

A page number within the paginated result set.

page_sizeintegerOptional

Number of results to return per page.

step_idstringRequired

Filter reference screenshots by step ID.

Responses

200Success

application/json

countintegerRequiredExample: 123

nextstring · uri · nullableOptionalExample: http://api.example.org/accounts/?page=4

previousstring · uri · nullableOptionalExample: http://api.example.org/accounts/?page=2

401

Authentication credentials were missing or invalid.

get/api/v2/visual-regression/reference-screenshots/

GET /api/v2/visual-regression/reference-screenshots/?step_id=text HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "stepId": "123e4567-e89b-12d3-a456-426614174000",
      "projectArtifactId": null,
      "screenshotUrl": null,
      "browserName": null,
      "osName": null,
      "screenSizeType": null,
      "runProfileId": null,
      "runProfileName": "text",
      "runMode": "server",
      "created": "2026-01-01T00:00:00.000Z",
      "modified": "2026-01-01T00:00:00.000Z"
    }
  ]
}

Create visual regression reference screenshot

post

Creates a new visual regression reference screenshot.

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Body

stepIdstring · uuidRequired

screenshotstring · uriRequired

browserNamestring · nullableOptional

osNamestring · nullableOptional

screenSizeTypestring,null · enum · nullableOptional

desktop - Desktop
mobile - Mobile
custom - Custom

Possible values:

runProfileIdstring · nullableOptional

runModestring,null · enum · nullableOptional

server - cloud
local - local
recording - recording

Possible values:

Responses

201Success

application/json

idstring · uuidRead-onlyRequired

stepIdstring · uuidRead-onlyRequired

projectArtifactIdstring · nullableRead-onlyRequired

screenshotUrlstring · nullableRead-onlyRequired

browserNamestring · nullableRead-onlyRequired

osNamestring · nullableRead-onlyRequired

screenSizeTypestring · nullableRead-onlyRequired

runProfileIdstring · nullableRead-onlyRequired

runProfileNamestringRead-onlyRequired

runModestring,null · enum · nullableRead-onlyRequired

server - cloud
local - local
recording - recording

Possible values:

createdstring · date-timeRead-onlyRequired

modifiedstring · date-timeRead-onlyRequired

400

Request body failed validation.

401

Authentication credentials were missing or invalid.

post/api/v2/visual-regression/reference-screenshots/

POST /api/v2/visual-regression/reference-screenshots/ HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 183

"stepId='123e4567-e89b-12d3-a456-426614174000'&screenshot='https://example.com'&browserName=null&osName=null&screenSizeType='desktop'&runProfileId=null&runMode='server'"

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "stepId": "123e4567-e89b-12d3-a456-426614174000",
  "projectArtifactId": null,
  "screenshotUrl": null,
  "browserName": null,
  "osName": null,
  "screenSizeType": null,
  "runProfileId": null,
  "runProfileName": "text",
  "runMode": "server",
  "created": "2026-01-01T00:00:00.000Z",
  "modified": "2026-01-01T00:00:00.000Z"
}

Retrieve visual regression reference screenshot

get

Returns a single visual regression reference screenshot.

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Path parameters

idstring · uuidRequired

A UUID string identifying this visual regression ref screenshot.

Responses

200Success

application/json

idstring · uuidRead-onlyRequired

stepIdstring · uuidRead-onlyRequired

projectArtifactIdstring · nullableRead-onlyRequired

screenshotUrlstring · nullableRead-onlyRequired

browserNamestring · nullableRead-onlyRequired

osNamestring · nullableRead-onlyRequired

screenSizeTypestring · nullableRead-onlyRequired

runProfileIdstring · nullableRead-onlyRequired

runProfileNamestringRead-onlyRequired

runModestring,null · enum · nullableRead-onlyRequired

server - cloud
local - local
recording - recording

Possible values:

createdstring · date-timeRead-onlyRequired

modifiedstring · date-timeRead-onlyRequired

401

Authentication credentials were missing or invalid.

404

Resource not found.

get/api/v2/visual-regression/reference-screenshots/{id}/

GET /api/v2/visual-regression/reference-screenshots/{id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "stepId": "123e4567-e89b-12d3-a456-426614174000",
  "projectArtifactId": null,
  "screenshotUrl": null,
  "browserName": null,
  "osName": null,
  "screenSizeType": null,
  "runProfileId": null,
  "runProfileName": "text",
  "runMode": "server",
  "created": "2026-01-01T00:00:00.000Z",
  "modified": "2026-01-01T00:00:00.000Z"
}

Update visual regression reference screenshot

put

Updates a visual regression reference screenshot.

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Path parameters

idstring · uuidRequired

A UUID string identifying this visual regression ref screenshot.

Body

screenshotstring · uriRequired

Responses

200Success

application/json

idstring · uuidRead-onlyRequired

stepIdstring · uuidRead-onlyRequired

projectArtifactIdstring · nullableRead-onlyRequired

screenshotUrlstring · nullableRead-onlyRequired

browserNamestring · nullableRead-onlyRequired

osNamestring · nullableRead-onlyRequired

screenSizeTypestring · nullableRead-onlyRequired

runProfileIdstring · nullableRead-onlyRequired

runProfileNamestringRead-onlyRequired

runModestring,null · enum · nullableRead-onlyRequired

server - cloud
local - local
recording - recording

Possible values:

createdstring · date-timeRead-onlyRequired

modifiedstring · date-timeRead-onlyRequired

400

Request body failed validation.

401

Authentication credentials were missing or invalid.

404

Resource not found.

put/api/v2/visual-regression/reference-screenshots/{id}/

PUT /api/v2/visual-regression/reference-screenshots/{id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 36

"screenshot='https://example.com'"

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "stepId": "123e4567-e89b-12d3-a456-426614174000",
  "projectArtifactId": null,
  "screenshotUrl": null,
  "browserName": null,
  "osName": null,
  "screenSizeType": null,
  "runProfileId": null,
  "runProfileName": "text",
  "runMode": "server",
  "created": "2026-01-01T00:00:00.000Z",
  "modified": "2026-01-01T00:00:00.000Z"
}

Delete visual regression reference screenshot

delete

Deletes a visual regression reference screenshot.

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Path parameters

idstring · uuidRequired

A UUID string identifying this visual regression ref screenshot.

Responses

204

No response body

No content

401

Authentication credentials were missing or invalid.

404

Resource not found.

delete/api/v2/visual-regression/reference-screenshots/{id}/

DELETE /api/v2/visual-regression/reference-screenshots/{id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

No content

Update visual regression reference screenshot

patch

Updates a visual regression reference screenshot.

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Path parameters

idstring · uuidRequired

A UUID string identifying this visual regression ref screenshot.

Body

screenshotstring · uriOptional

Responses

200Success

application/json

idstring · uuidRead-onlyRequired

stepIdstring · uuidRead-onlyRequired

projectArtifactIdstring · nullableRead-onlyRequired

screenshotUrlstring · nullableRead-onlyRequired

browserNamestring · nullableRead-onlyRequired

osNamestring · nullableRead-onlyRequired

screenSizeTypestring · nullableRead-onlyRequired

runProfileIdstring · nullableRead-onlyRequired

runProfileNamestringRead-onlyRequired

runModestring,null · enum · nullableRead-onlyRequired

server - cloud
local - local
recording - recording

Possible values:

createdstring · date-timeRead-onlyRequired

modifiedstring · date-timeRead-onlyRequired

400

Request body failed validation.

401

Authentication credentials were missing or invalid.

404

Resource not found.

patch/api/v2/visual-regression/reference-screenshots/{id}/

PATCH /api/v2/visual-regression/reference-screenshots/{id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 36

"screenshot='https://example.com'"

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "stepId": "123e4567-e89b-12d3-a456-426614174000",
  "projectArtifactId": null,
  "screenshotUrl": null,
  "browserName": null,
  "osName": null,
  "screenSizeType": null,
  "runProfileId": null,
  "runProfileName": "text",
  "runMode": "server",
  "created": "2026-01-01T00:00:00.000Z",
  "modified": "2026-01-01T00:00:00.000Z"
}

Resolve visual regression review

post

Resolves failed visual regression checks. Use set_new_reference to accept the observed screenshot as the new baseline, or set_new_max_difference to raise the step's allowed difference to just above the observed value. Provide exactly one of stepRunId or testRunId.

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Body

typestring · enumRequired

set_new_max_difference - Max Difference
set_new_reference - Set New Reference

Possible values:

testRunIdstring · uuidOptional

stepRunIdstring · uuidOptional

Responses

200

No response body

No content

400

Request body failed validation.

401

Authentication credentials were missing or invalid.

post/api/v2/visual-regression/resolve/

POST /api/v2/visual-regression/resolve/ HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 135

"type='set_new_max_difference'&testRunId='123e4567-e89b-12d3-a456-426614174000'&stepRunId='123e4567-e89b-12d3-a456-426614174000'"

No content

PreviousSettings

NextImport / Export

Last updated 47 minutes ago

Was this helpful?