v1

latestSwagger 2.02026-08-06114111152.5 KB

Screenshots

Capture a new screenshot batch

Queues a cross-browser screenshot of a given URL at a specified resolution. Rendering is asynchronous: this returns the batch ID only, so poll GET /v1/screenshots/:id until its state is done to collect the images.

post/v1/screenshots

Request body

urlstring required

Page URL to screenshot.

resolutionstring required

Browser viewport (e.g. "1920x1080").

browsersstring[] required

Array of { browser, version, os } triples (or browser_ids) to render with.

wait_timeinteger

Seconds to wait after page load before snapping.

fullpageboolean

Capture the entire scrollable page instead of just the viewport.

callback_urlstring

POST callback URL invoked when the batch finishes processing.

Response

Capture a new screenshot batch

idinteger required

Numeric batch ID to poll with GET /v1/screenshots/:id.

urlstring required

URL that will be screenshotted.

resolutionstring required

Browser viewport resolution.

wait_timeinteger required

Seconds each browser waits after load before capturing.

callback_urlstring required

Only present when a callback_url was supplied on the request.