The Visual Regression API for Developers & CI Pipelines
Integrate zero-code cloud screenshot testing into GitHub Actions, GitLab CI, custom webhooks, or internal dev tools using our OpenAPI REST endpoints and TypeScript SDK.
Programmable Visual Testing at Scale
Everything you can do in the RegressionBot UI can be controlled via API calls. Start runs, manage baselines, retrieve status, and inspect diffs programmatically.
REST & OpenAPI 3.0
Standard OpenAPI 3.0 specification with complete schemas. Generate client SDKs in Python, Go, Java, or Rust with zero friction.
Flexible Comparison Modes
Compare Preview URLs against stored managed baselines or run live-vs-live origin comparisons (e.g. staging vs production) in a single API call.
Programmatic Approvals
Approve job regressions or promote new baseline snapshots programmatically via simple POST requests to lock in intentional design updates.
cURL Request
curl -X POST "https://api.regressionbot.com/job" \
-H "Authorization: Bearer $REGRESSIONBOT_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"project": "web-app",
"testOrigin": "https://staging.myapp.com",
"devices": ["Desktop Chrome", "iPhone 12"]
}'TypeScript SDK
import { RegressionBot } from "@regressionbot/sdk";
const client = new RegressionBot({ apiKey: process.env.REGRESSIONBOT_API_KEY });
const job = await client.jobs.create({
project: "web-app",
testOrigin: "https://staging.myapp.com",
});
console.log(job.jobId);Stop squinting at red pixels.
When a layout changes, RegressionBot doesn't just throw a broken test and a red box at you. It uses vision models to understand the DOM and explain exactly what changed—and whether it matches your intent.
Changes detected:
- The hero icon was updated from a square to a checkmark (A).
- A new "Admin Dashboard" navigation item was added to the sidebar (B).
- Text phrasing in the configuration paragraph was modified (C, D).
- A new "Project Configuration Locking" section was inserted (E).
- The active state indicator in the Table of Contents was shifted (F).
✓ These changes match the provided PR description: "Add Admin Dashboard to sidebar and document configuration locking."
Storage Configuration
Learn how to configure Pulse to preserve visual snapshot records and perform comparisons across pipeline runs.
Configure Pulse to preserve visual snapshot records securely in Csecure cloud storage and comparing from Dstored baseline images on future pipeline runs.
Lock parameters during a run to prevent visual baseline regression drift across environments.
Frequently asked questions
Ready to ship with confidence?
Start catching visual changes before they reach production. Start your 7-day free trial today. No credit card required.