Quick Start
This guide will help you capture your first screenshot in under 5 minutes.
1. Create an Account
Sign up for a free account at app.shotone.io. The free plan includes 200 screenshots per month — no credit card required.
2. Get Your API Key
- Sign in to your dashboard at app.shotone.io
- Go to API Keys from the sidebar
- Click Create New Key
- Copy the key immediately — it is only shown once
Your API key starts with sk_live_ and looks like this:
sk_live_xxxxxxxxxxxxxxxxxxxxxxxx Important: Store your API key securely. Never expose it in client-side code or commit it to version control. If you lose it, you'll need to create a new one.
3. Make Your First Request
Replace YOUR_API_KEY with the key you copied and run:
curl -X POST "https://api.shotone.io/screenshot" \
-H "X-API-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"url": "https://example.com"}' \
--output screenshot.png If successful, you'll have a screenshot.png file in your current directory.
4. Customize Your Screenshot
Add more options to customize the output:
curl -X POST "https://api.shotone.io/screenshot" \
-H "X-API-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"url": "https://example.com",
"format": "webp",
"quality": 90,
"fullPage": true,
"device": "iphone-15-pro",
"blockAds": true
}' \
--output screenshot.webp 5. Use the Playground
Don't want to build API requests manually? Use the Playground in your dashboard to configure screenshots visually.
The Playground lets you:
- Set any URL and preview the screenshot in real time
- Choose device profiles, formats, quality, and all other options with a visual UI
- Toggle content blocking (ads, popups, cookie banners) with checkboxes
- Get the generated API request automatically — copy it and use it in your code
Tip: The Playground is the fastest way to experiment with all API options and get a working request you can drop into your codebase.