API Reference
Builds
API endpoints for managing visual regression test builds.
Builds represent a single run of visual regression tests, typically triggered by a CI pipeline or CLI command.
build.list
List builds with optional filtering.
| Type | Query |
| Auth | Protected |
Input:
{
projectId?: string; // Filter by project
status?: "running" | "passed" | "failed" | "pending";
limit?: number; // Max results
}Response: Build[]
build.byId
Get a build by ID with its comparisons.
| Type | Query |
| Auth | Protected |
Input:
{
id: string;
}Response:
{
id: string;
projectId: string;
branch: string;
commitSha: string | null;
commitMessage: string | null;
status: "running" | "passed" | "failed" | "pending";
totalComparisons: number;
totalDiffs: number;
totalNew: number;
createdAt: string;
finishedAt: string | null;
comparisons: Comparison[];
}build.create
Create a new build. Usually called at the start of a CI run.
| Type | Mutation |
| Auth | Protected |
Input:
{
projectId: string;
branch: string;
commitSha?: string;
commitMessage?: string;
}build.finish
Finalize a build, calculating totals and determining pass/fail status.
| Type | Mutation |
| Auth | Protected |
Input:
{
id: string;
}Response: Build with calculated totalComparisons, totalDiffs, totalNew, and status.
build.delete
Delete a build and its associated comparisons.
| Type | Mutation |
| Auth | Protected |
Input:
{
id: string;
}