Help Center
Simple guides to get you started
Understanding API Keys
Think of API keys like a special password that lets your apps talk to URLPixel. Here's everything you need to know, explained simply.
What exactly is an API key?
🏠 Think of it like a house key
Only YOU have the key to your screenshots
- Only YOU have the key to your screenshots
- It unlocks access to URLPixel's features
- Keep it safe, just like you would your house key
urlpx_your_secret_key_here
Your unique API key
Types of API keys
Full-Access Keys
- Access all sites in your account
- Requires site_id in every request
- Format: up_abc123...
up_1234567890abcdef...
Site-Scoped Keys
- Limited to specific sites
- Automatic site selection
- Optional domain restrictions
up_abc123_site_xyz789
🔒 Enhanced Security
Site-scoped keys provide better security for specific projects
Site-scoped keys are perfect for client work, integrations, or when you want to limit API access to specific projects. They can't access other sites in your account, making them much safer to share or embed.
Perfect for:
- • Client projects
- • Third-party integrations
- • Team collaboration
- • Public-facing apps
Security benefits:
- • Limited site access
- • Domain restrictions
- • Easier key rotation
- • Reduced blast radius
How to get your first API key
Sign up for URLPixel
Create your free account - no credit card needed
Visit urlpixel.com and click 'Sign Up'. You can use Google, GitHub, or email.
Go to your dashboard
Once signed in, you'll see your dashboard
Look for the navigation menu on the left side of your screen.
Click 'Settings' or 'API Keys'
Find the API key management section
It's usually in the Settings page or has its own dedicated section.
Create your first API key
Click 'Create New API Key' and give it a name
Name it something like 'My First Key' or 'Website Project' so you remember what it's for.
What your API key looks like
Your API Key
Created just now
Keep your API key safe!
Security best practices
- • Don't share it publicly (like in GitHub or forums)
- • Don't put it in your website's front-end code
- • Store it in environment variables or secure config files
- • If you think it's compromised, regenerate it immediately
How to use your API key
curl -X POST https://urlpixel.com/api/screenshot \
-H "X-API-Key: YOUR_API_KEY_HERE" \
-H "Content-Type: application/json" \
-d '{
"url": "https://example.com",
"site_id": "your_site_id",
"quality": "high"
}'💡 Pro tip
How URLPixel knows it's really you
Replace YOUR_API_KEY_HERE with your actual API key. The X-API-Key header is how URLPixel knows it's really you!
Common questions
Can I have multiple API keys?
Yes! You can create different keys for different projects. This helps you stay organized and makes it easier to manage access.
What if I lose my API key?
No worries! Just go to your dashboard and create a new one. You can delete the old key for security.
Why is my API key not working?
Make sure you're including the 'X-API-Key' header in your requests and that you've copied the key correctly (no extra spaces!).
Do API keys expire?
No, URLPixel API keys don't expire automatically. They'll work until you delete them or regenerate new ones.
What's the difference between full-access and site-scoped API keys?
Full-access keys can work with all sites in your account but require you to specify site_id in every request. Site-scoped keys are limited to specific sites but automatically fill in the site_id, making requests simpler and more secure.
How do domain restrictions work?
When you create a site-scoped API key with domain restrictions, it can only take screenshots of URLs on those specific domains. This prevents misuse if your API key is compromised. Subdomains are automatically included (example.com allows blog.example.com).
Can I change a site's domain restrictions?
Yes! You can update a site's allowed domains anytime through the dashboard or API. Existing API keys will immediately respect the new restrictions.