API

Use our API for custom integration.

Request Screenshot Data

POST https://api-screenshot.visual-knight.io/v1

This endpoint allows you to send an image to our backend which will perform the regression

Headers

Name	Type	Description
x-api-key	string	Authentication token

Request Body

Name	Type	Description
autoBaseline	boolean	Accept automatically the first result of an variation
additional	object	Additional information (maximum 1 level) Add your webdriver capabilities with the key capabilities to provide us information that we can autodetect the browser and device.
misMatchTolerance	number	The mismatch tolerance for the test (max 1.00, min 0.00)
test	string	Identifier against which test the screenshot will be compared
project	string	Project id or name

200 You receive the presigned url where you have to upload the screenshot and the created testSessionId

{
    url: "MY_PRESIGNED_URL",
    testSessionId: "SOME_TEST_SESSION_ID"
}

400

{
    "message": "Not all required fields are set."
}

403

{
    "message": "Not Authorized! Check if your key is set correct."
}

POST https://api-screenshot.visual-knight.io/v1

Request Body

Name	Type	Description
deviceName	string	capabilities

200

POST https://api-screenshot.visual-knight.io/v1

Request Body

Name	Type	Description
deviceName	string	Note

200

POST https://api-screenshot.visual-knight.io/v1

Request Body

Name	Type	Description
browserName	string	which was used

200

Upload screenshot

PUT https://yourpresigned.url/

Uploads the decoded screenshot to the presigned url endpoint The screenshot must be decoded as Base64 added via body You receive the presigned url from the Request Screenshot Data Api

Headers

Name	Type	Description
Content-Type	string	Must be set to "image/png"

200

Testsession Status

GET https://api-testsession.visual-knight.io/v1

Requests the status for a given test session id

Query Parameters

Name	Type	Description
testSessionId	string	The id of the requesting Testsession

200 JSON with the Testsession data

{
  /**
   * The value of the mismatch with the baseline comparison
   * if no baseline exists this value is null
   */
  misMatchPercentage: number | null;
  // Has the screenshot the same dimension like the baseline
  isSameDimensions: boolean | null;
  
  /**
   * link to the test session in visual knight if an error occures
   * An error can be e.g.: no baseline, mismatch higher than allowed
   */
  link: string;
}