Screenshot Website
Render up to 3 of the site’s pages to images; returns short-lived signed URLs.
Renders the DRAFT (current saved content) — identical to the live site
whenever has_unpublished_changes is false. Uses the shared website
render core: the same isolated BrowserLane.WEBSITE browsers, JS-on
live lane with JS-off fallback (js_disabled marks a degraded capture),
and full-page capture the in-app export uses. Binary delivery matches the
export pattern: signed URLs, never inlined bytes.
Requires edit permission on the site (renders are an editor affordance and consume scarce browser capacity — the same gate as the in-app export).
Authorizations
API key from Settings > Developer > REST API
Headers
Calendar-dated API version pin. New integrations should pin 2026-05-01 to opt into the newest response shapes. For back-compat the server also accepts requests with no header and resolves them to the current default (today: 2026-04-12); that default advances on each sunset date. Any unsupported value returns 400 unsupported_version.
2026-04-12, 2026-05-01 "2026-05-01"
Path Parameters
Body
Page route paths to capture (default: the homepage). At most 3 per call.
1 - 3 elements1 - 500^\S+$Viewport to render at (desktop=1440, tablet=768, mobile=375 CSS px wide).
desktop, tablet, mobile Image encoding of the captures.
jpg, png Device scale factor (default 2; a capture over the pixel budget steps down automatically).
1 <= x <= 2Response
Successful Response
The response is of type Response Websitesscreenshot · object.