Request
Screenshots
POST /api/screenshots accepts a public URL and returns image bytes. Send a viewport name, not a width and height.
Body
All three fields are required. A success response is the image, with content type image/png or image/jpeg. An error is JSON with a message.
| Parameter | Type | Required | Notes |
|---|---|---|---|
url | string | Yes | Public http or https URL. |
viewport | string | Yes | desktop, tablet, or mobile. |
format | string | Yes | png or jpg. jpeg is accepted as jpg. |
What is kept
A successful call with an API key stores the viewport, the format, and the image on the workspace. Download that image later from the dashboard request table. The public homepage demo uses the same route without a key and does not store the image. The signed-in dashboard can send the same body to /api/dashboard/screenshots, which counts against the workspace quota and keeps the image.
Viewport sizes
- Desktop: 1280×720
- Tablet: 768×1024
- Mobile: 390×844