Applitools Eyes API

Name: Applitools Eyes API API
Brand: Applitools Eyes API
Availability: InStock

★ Only Publicly Available OpenAPI DocumentDeveloper ToolsTesting QaapiKey8 EndpointsREST

For Agents

Read visual test batch results, manage batch properties, comment on visual diffs, and set SCM commit checks for visual review pipelines.

Quickstart

Get started with Applitools Eyes API in minutes using your preferred integration method.

# Add to your MCP client config (Claude Desktop, Cursor, Windsurf)
{
  "jentic": {
    "url": "https://api.jentic.com/mcp",
    "auth": "oauth"
  }
}

# Then ask your agent:
"get applitools visual test batch results"

# → Jentic returns the GET /events tool with parameter schema, agent executes.

Capabilities

What an agent can do with Applitools Eyes API API.

Fetch the result and aggregated statistics of a visual test batch by batchId

Update batch metadata such as name, branch, and accessibility properties

Post discussion comments and reactions on a visual diff to coordinate review

Set a commit status on a connected SCM provider so PR checks reflect visual review state

GET STARTED

Start building with Applitools Eyes API API

Explore with Jentic

View OpenAPI Document

Use for: I want to fetch the pass/fail status of my latest visual test batch, Update the name and branch of an Applitools batch from CI, Post a discussion comment on a visual diff awaiting review, Set a GitHub commit status for an Applitools visual review check

Not supported: Does not run visual checks, drive browsers, or capture screenshots — use the Applitools SDK for execution and this API for batch management, comments, and SCM status only.

Jentic publishes the only available OpenAPI document for Applitools Eyes API, keeping it validated and agent-ready.

Jentic publishes the only available OpenAPI specification for Applitools Eyes API, keeping it validated and agent-ready. The Applitools Eyes Server REST API exposes management operations on top of Applitools' visual testing platform — read batch results and statistics, set or update batch properties, post discussion comments on visual diffs, set SCM commit statuses for visual review checks, and validate API keys. The eight endpoints are designed for CI integration and dashboard automation, not for executing the visual checks themselves (which run through Applitools SDKs).

Use Cases

Patterns agents use Applitools Eyes API API for, with concrete tasks.

★ CI Visual Review Gate

After a CI run executes Applitools visual checks via the SDK, the same pipeline calls /scm/commits/{sha}/set-status to mark the GitHub or GitLab commit as success or failure based on the batch outcome. This blocks merges on unresolved visual diffs without requiring developers to log into the Applitools dashboard. The full status round-trip uses two endpoints — read the batch, set the commit status.

Read GET /batches/{batchId}, then POST /scm/commits/{sha}/set-status with status=failure if unresolved>0

Visual Diff Review Bot

A review bot watches Applitools batches in a target branch, posts discussion comments via /discuss/{discussionId} when a visual diff awaits human review, and resolves or escalates threads as engineers respond. The bot uses /batches/{batchId}/properties to tag batches with the responsible team so notifications route correctly.

POST a comment on /discuss/{discussionId} mentioning the design owner team and tag batch with property 'team:checkout'

Visual QA Dashboard

An internal dashboard polls /batches and /batches/{batchId}/properties to render a live view of visual test health across branches, surfacing the count of unresolved diffs, the dominant failing baseline, and trend over time. The dashboard validates each user's API key through /auth/api-key-validation before scoping queries to their team.

Validate API key with GET /auth/api-key-validation, then list the last 50 batches and aggregate unresolvedCount per branch

AI Agent Visual Triage

An AI agent uses Jentic to triage failed Applitools batches — reading batch results, summarizing the diff regions, posting a contextual discussion comment, and updating the SCM commit status. Jentic vaults the Applitools API key and the agent only sees the X-Eyes-Api-Key header value at execution time.

Search Jentic for 'get applitools batch results', call GET /batches/{batchId}, summarise unresolved diffs, and POST a discussion comment with the summary

Key Endpoints

8 endpoints — jentic publishes the only available openapi specification for applitools eyes api, keeping it validated and agent-ready.

METHOD

PATH

DESCRIPTION

GET

/batches/{batchId}

Get the result and metadata of a visual test batch

GET

/batches

List visual test batches

GET

/batches/{batchId}/properties

Read batch properties such as name, branch, and tags

POST

/discuss/{discussionId}

Post a discussion comment on a visual diff

POST

/scm/commits/{sha}/set-status

Set a commit status on a linked SCM repository

GET

/auth/api-key-validation

Validate an Applitools API key

GET

/batches/{batchId}

Get the result and metadata of a visual test batch

GET

/batches

List visual test batches

GET

/batches/{batchId}/properties

Read batch properties such as name, branch, and tags

POST

/discuss/{discussionId}

Post a discussion comment on a visual diff

POST

/scm/commits/{sha}/set-status

Set a commit status on a linked SCM repository

Why though Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

The Applitools API key is a long-lived token. Jentic stores it encrypted in the MAXsystem vault and only attaches it to the X-Eyes-Api-Key header at the moment of execution, so the agent never sees the secret value.

Intent-based discovery

Agents search Jentic with intents like 'get applitools batch results' or 'set commit status for visual review' and Jentic returns the matching operation with its parameter and response schema.

Time to first call

Direct integration: half a day reading docs and writing an HTTP client. Through Jentic: under 30 minutes — search, load, execute against eight already-modeled operations.

Related APIs

Alternatives and complements available in the Jentic catalogue.

Alternative

Percy API

Visual review platform with a similar batch-and-comment model

Pick Percy when the team is already on BrowserStack's stack; pick Applitools for Visual AI-based diffing across complex UIs.

Complementary

BrowserStack API

Cross-browser test execution that pairs with Applitools for the visual layer

Use BrowserStack to run tests across browsers and devices; use Applitools to assert visual correctness on those runs.

Complementary

GitHub REST API

Read PR context and post review comments alongside Applitools commit statuses

Use GitHub to find the PR for a commit; use Applitools to read the batch and set the corresponding visual check status.

FAQs

Specific to using Applitools Eyes API API through Jentic.

Why is there no official OpenAPI spec for Applitools Eyes API?

Applitools does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call Applitools Eyes API via structured tooling. It is validated against the live API and kept up to date. Get started at https://app.jentic.com/sign-up.

What authentication does the Applitools Eyes API use?

The API uses an API key in the X-Eyes-Api-Key header. You generate the key from the Applitools dashboard. Through Jentic the key is stored encrypted in the MAXsystem vault and injected at execution time, so the raw key never enters the agent's context.

Can I run a visual check through this API?

No — visual checks themselves are executed by the Applitools SDK in your test runner (Cypress, Playwright, Selenium, etc.). This REST API exposes management operations on top of completed batches: reading results, posting comments, and setting commit statuses.

How do I block a pull request on unresolved visual diffs?

Read GET /batches/{batchId} to get unresolvedCount, then POST /scm/commits/{sha}/set-status with status=failure when unresolvedCount > 0. The connected GitHub or GitLab repository will reflect the failed check on the PR.

How do I read Applitools batch results through Jentic?

Run pip install jentic, search 'get applitools batch results', and call GET /batches/{batchId} with the batchId returned by your test run. Jentic injects the X-Eyes-Api-Key automatically and returns the batch JSON for your agent to consume.

Are there rate limits on the Applitools Eyes API?

Applitools enforces per-account rate limits that are not published in the spec. In practice the management endpoints are tolerant of CI burst patterns; if you exceed the limit the API returns 429. Cache batch reads where possible and avoid polling the same batch more than once per few seconds.