Introduction

Quickstart

Get from zero to your first screenshot in under a minute. No SDK, no auth, just HTTP.

API key required

All requests need an X-API-Key header. Sign in and request a key from your dashboard — once approved, use it in every request below.

1. Confirm the API is up

A simple GET request to the root tells you that the service and its warm-booted browser are alive.

curl https://api.example.com/

2. Capture your first screenshot

Send a JSON body to /api/screenshot and pipe the binary response straight to a file.

curl -X POST "https://api.example.com/api/screenshot" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: YOUR_API_KEY" \
  -d '{"url":"https://example.com"}' \
  --output example.png

3. What you'll get back

The response is a raw PNG with Content-Type: image/png. On error you'll receive a JSON body with a detail field — see the error handling page.

Next steps

Full API reference

Every parameter, response, and code sample for /api/screenshot.

Open the Playground

Build a request visually and copy the snippet for your stack.