Control the browser viewport size and capture behavior.
Viewport Dimensions
| Parameter | Default | Range | Description |
|---|
viewport.width | 1920 | 100-3840 | Width in pixels |
viewport.height | 1080 | 100-2160 | Height in pixels |
{
"url": "https://example.com",
"viewport": {
"width": 1280,
"height": 720
}
}
Common Viewport Sizes
| Device | Width | Height |
|---|
| Desktop HD | 1920 | 1080 |
| Desktop | 1280 | 720 |
| Laptop | 1366 | 768 |
| Tablet Portrait | 768 | 1024 |
| Tablet Landscape | 1024 | 768 |
| Mobile | 375 | 667 |
| Mobile Large | 414 | 896 |
Full Page Capture
Capture the entire scrollable page, not just the visible viewport.
{
"url": "https://example.com",
"isFullPage": true
}
Full page captures may take longer and produce larger files for long pages.
Viewport vs Full Page
| Option | Captures | Best For |
|---|
isFullPage: false | Visible viewport only | Above-the-fold content |
isFullPage: true | Entire scrollable page | Full page archives, PDFs |
Examples
Desktop Screenshot
{
"url": "https://example.com",
"viewport": {
"width": 1920,
"height": 1080
}
}
Mobile Screenshot
{
"url": "https://example.com",
"viewport": {
"width": 375,
"height": 667
}
}
Full Page PDF
{
"url": "https://example.com",
"format": "pdf",
"isFullPage": true
}
Custom Aspect Ratio
{
"url": "https://example.com",
"viewport": {
"width": 1200,
"height": 630
}
}
The 1200x630 size is ideal for social media OG images.
