Documentation IndexFetch the complete documentation index at: /llms.txtUse this file to discover all available pages before exploring further.
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Create, complete, and query visual regression test runs
POST /api/v1/vrt/runs/:project
X-API-Key
branch
string
commit_sha
trigger
duration
double
screens
json
captures
file[]
diffs
{ "run_id": "uuid", "status": "passed", "url": "https://grantiva.io/dashboard/vrt/runs/uuid", "screen_count": 8, "passed_count": 8, "failed_count": 0, "new_count": 0 }
PATCH /api/v1/vrt/runs/:project/:runId
GET /api/v1/vrt/runs/:project
{ "runs": [ { "id": "uuid", "branch": "main", "commit_sha": "abc123", "status": "passed", "screen_count": 8, "passed_count": 8, "failed_count": 0, "created_at": "2025-03-10T12:00:00Z" } ] }
GET /api/v1/vrt/runs/:project/:runId
{ "run": { ... }, "screens": [ { "name": "Home", "status": "passed", "pixel_diff": 0.001, "perceptual_distance": 1.2 } ], "logs": "Build output..." }
GET /api/v1/vrt/runs/:project/:runId/screens/:screen/capture GET /api/v1/vrt/runs/:project/:runId/screens/:screen/diff
POST /api/v1/vrt/runs/:project/:runId/logs
{ "lines": "Log output to append..." }
Was this page helpful?