Query Parameter Authentication
For simple integrations, you can include your API key as a query parameter.
Usage
Add api_key to your request URL:
https://api.renderscreenshot.com/v1/screenshot?url=https://example.com&api_key=rs_live_xxxxx
Use Cases
This method is ideal for:
- Direct
<img>tag usage - og:image meta tags
- Simple URL-based integrations
Example: og:image Tag
<meta property="og:image" content="https://api.renderscreenshot.com/v1/screenshot?url=https://mysite.com&preset=og_card&api_key=rs_live_xxxxx" />
Security Considerations
Warning: API keys in URLs may be logged by browsers, proxies, and servers. For public-facing URLs, consider using signed URLs instead.
When using query parameter auth:
- Use test keys (
rs_test_) for development - Consider signed URLs for production
- Monitor your API usage for unexpected activity