SDK user guide

Click here to open the API Reference Guide

An SDK, or Software Development Kit, is a set of tools that software developers use to create applications for a specific platform or programming language. It typically includes libraries, APIs, documentation, and sample code that help developers build software more efficiently and effectively.

Applitools provides SDKs in a variety of languages to help you build testing scripts with Applitools Eyes. To get started with an SDK, you'll need to download and install it, and then follow the documentation and sample code provided.

The complete Applitools SDK Reference Guide is available at

Introduction articles

If you are new to Applitools Eyes, we recommend you read that articles in the Overview, in particular, the following pages are a good step by step introduction to the basics of writing an Eyes visual test:

  • Writing tests with the Eyes SDK

    This article describes how to implement visual tests with the Eyes SDK.

  • Introduction to the Ultrafast Grid

    This article describes the Applitools Ultrafast Grid which allows you perform visual testing across multiple browsers and devices.

  • Writing visual tests that use the Ultrafast Grid

    This article describes how to write tests for the Ultrafast Grid

Advanced topics

  • Configuring Eyes using the SDK

    This article describes the three basic patters for configuring Eyes, namely configurations used across many tests, test specific configuration and checkpoint specific configuration.

  • Test suite configuration

    This article presents some key configuration values, that are normally set once per test suite to customize Eyes to the test environment.

  • How to group tests into batches using the SDK

    This article describes how to use the eyes$setbatch$mOrP in the Eyes SDK to define that the results of multiple tests should be grouped together in the Test Manager.

  • Setting up Batch completion notification

    This article explains how to setup the SDK so that you get notifcations when a Batch completes.

  • Ultrafast Grid configuration

    This article describes how to configure the Ultrafast Grid, including: defining which browser configurations should be rendered, and setting the baseline environment.

  • Migrating code to use the Ultrafast Grid

    This article describes how to change code written before the Ultrafast Grid was available, to use the Ultrafast Grid compatible components.

  • The Eyes SDK check Fluent API

    This overview presents a high level overview of the Fluent API used with the eyes$check methods. In this overview you will be introduced to all the available methods implemented by this API and how they can be used together to create and configure your checkpoints.

  • Visual locators

    This article describes how you can use Eyes to find the position of visual entities on your page. You can use this to trigger instead of using DOM based locators.

  • Handling viewport-dependent JavaScript

    This article describes how to successfully test pages that use JavaScript to impact the layout or content of the application page.