GET
/v1/screenshotCapture full-page or element screenshots with customizable options.
📸 Website Screenshots
High-quality screenshots with dark mode support, ad blocking, viewport presets, and CDN delivery. Perfect for thumbnails, previews, and archiving.
Available Endpoints
GET
/v1/screenshotReturns binary image data directly
GET
/v1/screenshot/urlReturns JSON with CDN URL to the screenshot
Parameters
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
url | string | - | URL to screenshot | |
width | integer | 1280 | Viewport width in pixels | |
height | integer | 800 | Viewport height in pixels | |
viewport | string | - | Preset viewport (desktop, mobile, tablet, etc.) | |
fullPage | boolean | false | Capture entire scrollable page | |
format | enum | png | png | jpeg | webp | |
quality | integer | 80 | JPEG/WebP quality (1-100) | |
delay | integer | 0 | Wait ms before capture | |
selector | string | - | CSS selector to capture specific element | |
darkMode | boolean | false | Enable dark mode preference | |
deviceScale | integer | 1 | Device pixel ratio (1-3) | |
blockAds | boolean | true | Block ads and trackers |
Viewport Presets
Use the viewport parameter for common sizes:
desktop1920×1080laptop1366×768tablet768×1024mobile375×812twitter-card1200×628og-image1200×630facebook1200×630instagram1080×1080Request Examples
curl "https://api.katsau.com/v1/screenshot?url=https://example.com" \
-H "Authorization: Bearer ks_live_your_api_key" \
-o screenshot.pngResponse (CDN URL)
{
"success": true,
"data": {
"url": "https://cdn.katsau.com/screenshots/ss_a1b2c3d4.png",
"cached": false,
"width": 1280,
"height": 800,
"format": "png",
"size_bytes": 245000,
"expires_at": "2024-01-16T00:00:00Z"
},
"meta": {
"request_id": "req_abc123xyz",
"response_time_ms": 2345,
"cache_hit": false
}
}Plan Limits
| Plan | Availability | Max Size |
|---|---|---|
| Free | Not Available | - |
| Starter | Not Available | - |
| Pro | Included | 2560×1440 |
| Enterprise | Included | 3840×2160 |
Use Cases
- •Thumbnails: Generate previews for bookmarks or link lists
- •Visual Testing: Capture before/after screenshots for QA
- •Archiving: Create visual snapshots of web pages
- •Social OG Images: Use viewport=og-image for perfect sizing