Documentation
Guides and API reference for the Screenshot API.
Welcome to the Screenshot API docs. Start with Getting started to sign up, create an API Key, and capture your first Screenshot in under five minutes.
What you can do
- Render a URL —
POST /screenshotreturns PNG, JPEG, or WebP bytes, or a JSON envelope with a hosted URL. - Authenticate with an API Key — pass
Authorization: Bearer shot_…on every request. - Control the browser — viewport, device pixel ratio, full-page capture, ad blocking, and wait conditions are all request-body options.
Sections
| Topic | Description |
|---|---|
| Getting started | Sign up, create a key, first curl |
| Authentication | Header format and key management |
| Examples | Curl, Python, and Node samples |
| Screenshot reference | Full request and response reference |
| Errors | Error codes and how to fix them |
| Rate limits & quotas | Per-minute, concurrency, and monthly limits |
| Caching & idempotency | Cache TTL and Idempotency-Key |
| Storage | JSON URLs and 30-day retention |