Capture a screenshot now
POST/api/v1/orgs/:org/checks/:checkUid/screenshots/capture
"Capture now": runs a browser or js check once, on demand, with the screenshot forced whatever the verdict (and whether or not the check's own screenshot option is on). The run goes through the check's own scheduling, so it executes where the check executes — one of its regions, on a shared worker or on the organization's private agent — and its result is recorded like any other run. The call returns as soon as the run is scheduled; the capture appears in GET …/screenshots (trigger capture-now, or agent-upload from a private agent) once the run completes. A run that completes without a capture is reported as captureOutcome on that listing, matched by requestedAt. A js check only yields a capture if its script calls page.screenshot(). Rate limited to one request per check per minute and 20 per organization per hour; a refusal carries Retry-After. Requires write access (viewers get 403).
Request
Responses
- 202
- 400
- 401
- 403
- 404
- 409
- 429
The on-demand run is scheduled
The check type cannot capture a screenshot (only browser and js can)
Authentication required
Permission denied
Resource not found
The check has no scheduled run (it is disabled)
Rate limited (code RATE_LIMITED): one capture per check per minute, 20 per organization per hour. Retry-After gives the seconds until the refusing window reopens.