GET /v1/screenshot
The GET endpoint provides a simple way to capture screenshots using query parameters. Ideal for direct use in <img> tags and og:image meta tags.
Endpoint
GET https://api.renderscreenshot.com/v1/screenshot
Authentication
Include your API key as a query parameter:
?api_key=rs_live_xxxxx
Or use a signed URL for better security (see Signed URLs).
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
url |
string | Yes | The URL to screenshot (URL encoded) |
api_key |
string | Yes* | Your API key (*or use signed URL) |
preset |
string | No | Preset: og_card, twitter_card, full_page |
width |
integer | No | Viewport width in pixels |
height |
integer | No | Viewport height in pixels |
format |
string | No | Output format: png, jpeg, webp |
quality |
integer | No | Image quality 1-100 |
Response
Returns the screenshot binary with appropriate Content-Type header.
Examples
Basic Usage
<img src="https://api.renderscreenshot.com/v1/screenshot?url=https://example.com&api_key=rs_live_xxxxx" />
With Preset
<meta property="og:image" content="https://api.renderscreenshot.com/v1/screenshot?url=https://mysite.com/post/123&preset=og_card&api_key=rs_live_xxxxx" />
Custom Dimensions
https://api.renderscreenshot.com/v1/screenshot?url=https://example.com&width=800&height=600&api_key=rs_live_xxxxx
Security Note
When using API keys in publicly visible URLs (like og:image tags), consider using signed URLs instead to prevent key exposure.