Scraper API · Page Screenshot

Page Screenshot

POST /api/ss-screenshot

https://api.sneakypeekai.com

Capture a screenshot of a public page. A successful capture always returns the image, including login screens and cookie banners. Choose JPEG or PNG, optionally capture the full scrollable page, and get readable text from the image when available. You may also send optional proxy, userAgent, and viewport. Send the options in the JSON body.

Uses 3 credits plus 1 request from your per-minute and daily caps. Only one screenshot runs at a time on this host. Credits refund on HTTP 4xx/5xx.

Authentication

Authenticate requests by sending your API key in the X-API-Key HTTP request header.

Mint and manage API keys in your Sneaky Peek AI Account → API Keys.

X-API-Key: $API_KEY

Parameters

Name	In	Type	Required	Notes
`X-API-Key`	header	`string`	yes	Your API key. Missing or wrong key returns 401.
`url`	body	`string`	yes	Public web page address (http or https).
`format`	body	`enum`	no	Image format: jpeg (default) or png.
`fullPage`	body	`boolean`	no	Set true to capture the full scrollable page. Default captures the visible viewport only.
`proxy`	body	`string`	no	Optional proxy URL for this request.
`userAgent`	body	`string`	no	Optional browser user agent for this request. user_agent is also accepted. Leave out to use the current desktop browser user agent.
`viewport`	body	`object or string`	no	Optional size as {"width":1920,"height":1080} or 1920x1080.

Request Example (curl)

curl -X POST "https://api.sneakypeekai.com/api/ss-screenshot" \
  -H "X-API-Key: $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://example.com","format":"jpeg","fullPage":false}'

Success Response Example (200 OK)

{
  "success": true,
  "message": "Screenshot captured successfully",
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "base64": "iVBORw0KGgo...",
  "retryCount": 0,
  "ocrText": "",
  "timestamp": "2026-08-23T20:00:00.000Z"
}

Common Error Status Codes

Status Code	When / Description
`400`	The page address is missing or is not a public http or https site.
`401`	The API key is missing or invalid.
`402`	Insufficient credits for this call.
`408`	The capture timed out.
`429`	You hit a key limit, or another screenshot is already running on this host.