Visual
For instructions on how to authenticate to use this endpoint, see API overview.
Endpoints
GET | |
GET | |
POST | |
GET | |
POST | |
POST | |
POST | |
POST | |
POST | |
GET |
Retrieve visual review repos runs counts
Review state counts for runs in this repo.
Required API key scopes
visual_review:readPath parameters
- repo_idstring
Response
Example request
GET /api /projects /:project_id /visual_review /repos /:repo_id /runs /countsExample response
Status 200
Retrieve visual review repos runs counts
Review state counts for runs in this repo.
Required API key scopes
visual_review:readPath parameters
- repo_idstring
Response
Example request
GET /api /projects /:project_id /visual_review /repos /:repo_id /runs /countsExample response
Status 200
List all visual review repos snapshots
Deduped baseline timeline for a snapshot identity. Newest first.
Required API key scopes
visual_review:readPath parameters
- identifierstring
- repo_idstring
- run_typestring
Query parameters
- limitinteger
- offsetinteger
Response
Example request
GET /api /projects /:project_id /visual_review /repos /:repo_id /snapshots /:run_type /:identifierExample response
Status 200
List all visual review repos snapshots
Deduped baseline timeline for a snapshot identity. Newest first.
Required API key scopes
visual_review:readPath parameters
- identifierstring
- repo_idstring
- run_typestring
Query parameters
- limitinteger
- offsetinteger
Response
Example request
GET /api /projects /:project_id /visual_review /repos /:repo_id /snapshots /:run_type /:identifierExample response
Status 200
Create visual review runs
Create a new run from a CI manifest.
Required API key scopes
visual_review:writeRequest parameters
- repo_idstring
- run_typestring
- commit_shastring
- branchstring
- snapshotsarray
- pr_numberinteger
- baseline_hashesobject
- unchanged_countinteger
- removed_identifiersarray
- purposestring
- metadataobject
Response
Example request
POST /api /projects /:project_id /visual_review /runsExample response
Status 201
Create visual review runs
Create a new run from a CI manifest.
Required API key scopes
visual_review:writeRequest parameters
- repo_idstring
- run_typestring
- commit_shastring
- branchstring
- snapshotsarray
- pr_numberinteger
- baseline_hashesobject
- unchanged_countinteger
- removed_identifiersarray
- purposestring
- metadataobject
Response
Example request
POST /api /projects /:project_id /visual_review /runsExample response
Status 201
Retrieve visual review runs
Get run status and summary.
Required API key scopes
visual_review:readPath parameters
- idstring
Response
Example request
GET /api /projects /:project_id /visual_review /runs /:idExample response
Status 200
Retrieve visual review runs
Get run status and summary.
Required API key scopes
visual_review:readPath parameters
- idstring
Response
Example request
GET /api /projects /:project_id /visual_review /runs /:idExample response
Status 200
Create visual review runs add snapshots
Add a batch of snapshots to a pending run (shard-based flow).
Required API key scopes
visual_review:writePath parameters
- idstring
Request parameters
- snapshotsarray
- baseline_hashesobject
Response
Example request
POST /api /projects /:project_id /visual_review /runs /:id /add-snapshotsExample response
Status 200
Create visual review runs add snapshots
Add a batch of snapshots to a pending run (shard-based flow).
Required API key scopes
visual_review:writePath parameters
- idstring
Request parameters
- snapshotsarray
- baseline_hashesobject
Response
Example request
POST /api /projects /:project_id /visual_review /runs /:id /add-snapshotsExample response
Status 200
Create visual review runs approve
Approve visual changes for snapshots in this run.
With approve_all=true, approves all changed+new snapshots and returns signed baseline YAML. With specific snapshots, approves only those.
Required API key scopes
visual_review:writePath parameters
- idstring
Request parameters
- snapshotsarray
- approve_allboolean
- commit_to_githubboolean
Response
Example request
POST /api /projects /:project_id /visual_review /runs /:id /approveExample response
Status 200
Create visual review runs approve
Approve visual changes for snapshots in this run.
With approve_all=true, approves all changed+new snapshots and returns signed baseline YAML. With specific snapshots, approves only those.
Required API key scopes
visual_review:writePath parameters
- idstring
Request parameters
- snapshotsarray
- approve_allboolean
- commit_to_githubboolean
Response
Example request
POST /api /projects /:project_id /visual_review /runs /:id /approveExample response
Status 200
Create visual review runs auto approve
CLI auto-approve: approve all and return baseline YAML for local write.
Required API key scopes
visual_review:writePath parameters
- idstring
Response
Example request
POST /api /projects /:project_id /visual_review /runs /:id /auto-approveExample response
Status 200
Create visual review runs auto approve
CLI auto-approve: approve all and return baseline YAML for local write.
Required API key scopes
visual_review:writePath parameters
- idstring
Response
Example request
POST /api /projects /:project_id /visual_review /runs /:id /auto-approveExample response
Status 200
Create visual review runs complete
Complete a run: detect removals, verify uploads, trigger diff processing.
Required API key scopes
visual_review:writePath parameters
- idstring
Response
Example request
POST /api /projects /:project_id /visual_review /runs /:id /completeExample response
Status 200
Create visual review runs complete
Complete a run: detect removals, verify uploads, trigger diff processing.
Required API key scopes
visual_review:writePath parameters
- idstring
Response
Example request
POST /api /projects /:project_id /visual_review /runs /:id /completeExample response
Status 200
Create visual review runs recompute
Re-evaluate quarantine and counts, update commit status, and optionally rerun the CI job.
Required API key scopes
visual_review:writePath parameters
- idstring
Response
Example request
POST /api /projects /:project_id /visual_review /runs /:id /recomputeExample response
Status 200
Create visual review runs recompute
Re-evaluate quarantine and counts, update commit status, and optionally rerun the CI job.
Required API key scopes
visual_review:writePath parameters
- idstring
Response
Example request
POST /api /projects /:project_id /visual_review /runs /:id /recomputeExample response
Status 200
List all visual review runs snapshots
Get all snapshots for a run with diff results.
Required API key scopes
visual_review:readPath parameters
- idstring
Query parameters
- limitinteger
- offsetinteger
Response
Example request
GET /api /projects /:project_id /visual_review /runs /:id /snapshotsExample response
Status 200
List all visual review runs snapshots
Get all snapshots for a run with diff results.
Required API key scopes
visual_review:readPath parameters
- idstring
Query parameters
- limitinteger
- offsetinteger
Response
Example request
GET /api /projects /:project_id /visual_review /runs /:id /snapshots