katsau Docs
GET/v1/screenshot

Capture 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/screenshot

Returns binary image data directly

GET/v1/screenshot/url

Returns JSON with CDN URL to the screenshot

Parameters

NameTypeRequiredDefaultDescription
urlstring-URL to screenshot
widthinteger1280Viewport width in pixels
heightinteger800Viewport height in pixels
viewportstring-Preset viewport (desktop, mobile, tablet, etc.)
fullPagebooleanfalseCapture entire scrollable page
formatenumpngpng | jpeg | webp
qualityinteger80JPEG/WebP quality (1-100)
delayinteger0Wait ms before capture
selectorstring-CSS selector to capture specific element
darkModebooleanfalseEnable dark mode preference
deviceScaleinteger1Device pixel ratio (1-3)
blockAdsbooleantrueBlock ads and trackers

Viewport Presets

Use the viewport parameter for common sizes:

desktop1920×1080
laptop1366×768
tablet768×1024
mobile375×812
twitter-card1200×628
og-image1200×630
facebook1200×630
instagram1080×1080

Request Examples

curl "https://api.katsau.com/v1/screenshot?url=https://example.com" \
  -H "Authorization: Bearer ks_live_your_api_key" \
  -o screenshot.png

Response (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

PlanAvailabilityMax Size
FreeNot Available-
StarterNot Available-
ProIncluded2560×1440
EnterpriseIncluded3840×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