Skip to main content
POST
Visual Tests
Manage and run visual tests across desktop, laptop, iPad, and mobile viewports. Dispatch the desired operation with the action field in the request body.

Actions

Headers

string
Optional caller-provided transaction identifier for tracing.

Request body

string
required
One of list, add, delete, results, run, or schedule.
object
Payload for the selected action.

Response

array
Returned by list. Each entry includes id, url, name, createdAt, running, and latest (a VisualLatestResult with status, takenAt, workflowId, and per-device imageUrl/analysis).
object
Returned by add.
string
Returned by run and schedule — the async job identifier.
Every successful response includes the X-Credits-Remaining header.