Screenshot
GET /api/v1/screenshot
Render any URL in a real browser and capture it as an image — full-page or above-the-fold, desktop or mobile. Ideal for previews, visual diffs and reports.
Query parameters
| Name | Type | Description |
|---|---|---|
url required | string | The page to capture. |
device optional | string | mobile (default) or desktop. |
Request
Response
200 · application/json
- {
- "url": "https://example.com",
- "device": "mobile",
- "fetchedUrl": "https://example.com/",
- "width": 412,
- "height": 2284,
- "image": "data:image/webp;base64,UklGRiY…"
- }
Response fields
| Field | Type | Description |
|---|---|---|
device | string | The device viewport used (mobile or desktop). |
fetchedUrl | string | The final URL after any redirects. |
width / height | integer | Rendered image size in pixels. |
image | string | A base64 data URI (WebP, or JPEG depending on the upstream render) — embed it directly or decode it to a file. |
This endpoint renders the page in a headless browser, so responses take a little longer than the static endpoints. See Errors.