Getting Started

Anonymous API (No Signup Required)

The fastest way to capture a screenshot. No authentication required—just pass a public URL and get back an image.

Simple GET Request

bash

curl "https://snap.i2dev.com/v1/screenshot?url=https://example.com"

Returns an image directly. Perfect for embeds, <img /> tags, and quick testing. If a capture fails, this endpoint still returns an uncached placeholder image describing the problem.

Customizable Options

bash

curl "https://snap.i2dev.com/v1/screenshot?url=https://example.com&width=1920&height=1080&format=jpeg"

Available parameters:

url (required) — The page to screenshot
width — Viewport width (default: 1280)
height — Viewport height (default: 720)
format — png or jpeg (default: jpeg; the authenticated API defaults to png)
fullPage — Capture the full scrollable page
waitUntil — Wait for load, domcontentloaded, or networkidle
waitForSelector — Wait for a CSS selector before capture
timezoneId and locale — Stabilize regional rendering
timeoutMs — Set the overall render timeout, up to the server maximum

Anonymous Limits

Anonymous requests are limited to 10 screenshots per day per IP, resetting at midnight UTC. For higher limits, priority rendering, and additional features, authenticate with an API key.

Anonymous failures return HTTP 200 with a standard 1280x720 PNG or JPEG placeholder so image embeds remain renderable. Inspect X-Snap-Result, X-Snap-Error-Code, X-Snap-Error-Status, and X-Snap-Request-Id for machine-readable diagnostics. Error placeholders use Cache-Control: no-store.

Authenticated API

For production use, CI/CD integration, and higher rate limits, use the authenticated API.

bash

curl -X POST https://snap.i2dev.com/v1/screenshots \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://example.com",
    "viewport": { "width": 1280, "height": 720 }
  }'

The response includes the screenshot URL and metadata:

json

{
  "jobId": "...",
  "request_id": "...",
  "imageUrl": "https://snap-i2dev-com.s3.amazonaws.com/...?X-Amz-...",
  "contentType": "image/png",
  "bytes": 12345,
  "durationMs": 987
}

Authentication

All authenticated API requests require an API key:

http

Authorization: Bearer YOUR_API_KEY

You can also use x-api-key if preferred:

http

x-api-key: YOUR_API_KEY

Error Codes

The authenticated API returns structured error responses with consistent HTTP statuses and codes:

Code	HTTP Status	Description
invalid_url	400	URL is malformed or uses an unsupported protocol
unsafe_url	400	URL resolves to a private/internal IP address
unauthorized	401	Missing or invalid API key
rate_limited	429	Too many requests. Check Retry-After header
navigation_timeout	504	Page failed to load within timeout
render_blocked	422	Target site blocked automated rendering

Authenticated API error responses include a request_id for debugging:

json

{
  "error": "URL resolves to a private IP address",
  "code": "unsafe_url",
  "request_id": "req_xyz789"
}