Help & Getting Started
Welcome to CaptureAPI. Whether you just redeemed a Lifetime code or signed up for the free tier, these 5 steps + the features index below cover everything you need. Want to compare plans first? See pricing details.
First steps
Step 1: Create your account
Sign up at /login or redeem your Lifetime coupon at /redeem with email + code. You get an account in <2 seconds.
Step 2: Save your API key
After redeem, your raw API key (cap_…) is shown ONCE on the success page AND sent via email as a permanent fallback. Store it in a password manager.
Step 3: Take your first screenshot
POST { url, viewport } to /api/v1/screenshot with X-API-Key header. Returns a JPEG/PNG by default; pass format=pdf for PDF export.
Step 4: Try the dashboard playground
Visit /dashboard to test capture interactively — paste a URL, choose a viewport, see the screenshot instantly. No code needed.
Step 5: Use OG image generation
POST { html, width, height } to /api/v1/og for Open Graph cards. Same auth, faster than full-page capture.
Features Index
Every feature CaptureAPI ships, how to reach it from the UI, and the API endpoint behind it.
| Feature | What it does | UI path | API |
|---|---|---|---|
| Screenshot API | Full-page, viewport, or selector screenshot from any URL. | /dashboard | POST /api/v1/screenshot |
| PDF Export | Convert any web page to a paginated PDF. | /dashboard | POST /api/v1/pdf |
| Open Graph Image Generation | Generate OG cards from HTML — perfect for social-share images. | — | POST /api/v1/og |
| Visual DiffComing soon | Pixel-accurate comparison between 2 URLs or 2 versions of the same URL. The renderer pipeline is still being wired — the endpoint currently returns 501 Not Implemented. | — | GET /api/v1/diff |
| Batch Capture | Submit multiple URLs at once, get a webhook callback with results. | — | POST /api/v1/batch |
| Demo capture | Try without an API key (rate-limited). | /dashboard | POST /api/v1/demo |
| Health endpoint | Service availability + region map. | — | GET /api/v1/health |
| Usage dashboard | Per-key request count + bandwidth + percentile latencies. | /dashboard | GET /api/v1/usage |
| API key management | Generate, regenerate, revoke keys from the dashboard. | /dashboard | POST /api/keys/regenerate · /api/keys/revoke |
Need help? Email hello@captureapi.dev — we reply within 48 hours.