Developer Documentation
RegressionBot is a visual regression testing platform designed to crawl, capture, and compare your web layouts. Catch unintended UI changes before they reach your customers.
Choose Your Integration Path
We provide multiple interfaces tailored for different engineering workflows—whether you prefer AI agents, programmatic SDKs, command-line runs, or raw HTTP integrations.
Getting Started & Quickstart
The fastest path to try RegressionBot. Run your first comparison directly from your terminal in under 3 minutes using our CLI.
Agentic Workflows (MCP)
Expose visual testing tools directly to Claude Code, Cursor, Windsurf, or Gemini. Enable AI to run and approve tests autonomously.
Node.js SDK & CI
Integrate regression audits inside Playwright, Jest, or custom CI runners. Complete with fully typed class structures.
REST API Reference
Integrate programmatically across arbitrary backend platforms. Leverage raw endpoints to trigger jobs and query status.
Organizations & Teams
Add team members, manage roles, and send email invites. API keys automatically carry org context — no pipeline changes needed.
Features Under the Hood
Parallel Captures
Runs comparisons concurrently utilizing serverless parallel scaling to minimize pipeline execution times.
Visual SSIM Analysis
Performs advanced Structural Similarity (SSIM) matching alongside pixel comparison, eliminating rendering antialiasing noise.
Element Masking
Easily blank out date markers, widgets, or third-party ads using the simple HTML data-vr-mask attribute.
AI-Powered Summarization
Get instantly readable summaries powered by our AI comparison engine that explain visual changes in plain English.