bottom
query integer Optional Example: 0
Y coordinate (in pixels, exclusive) of the crop box's bottom edge. 0 (default) extends the box to the source's bottom edge. Values beyond the source height are clamped to the bottom edge.
GET
/screenshot/thumbnail Retrieve thumbnail image
Options
Options are grouped for easier scanning, similar to parameter-focused docs.
App
query
filename
query string Optional Optional filename for Content-Disposition attachment
id
query integer Required Screenshot ID
left
query integer Optional Example: 0
X coordinate (in pixels, 0-based) of the crop box's left edge. Must be less than the source image width.
quality
query integer Optional Example: 100
JPEG/WEBP quality (1-100)
ratio
query enum(fit, fill) Optional Example: fit
Aspect ratio mode: fit (preserve) or fill (crop)
right
query integer Optional Example: 0
X coordinate (in pixels, exclusive) of the crop box's right edge. 0 (default) extends the box to the source's right edge. Values beyond the source width are clamped to the right edge.
scale
query number Optional Example: 1
Scale factor
shot
query integer Optional Example: 1
Which screenshot if multiple requested
top
query integer Optional Example: 0
Y coordinate (in pixels, 0-based) of the crop box's top edge. Must be less than the source image height.
zoom
query integer Optional Example: 100
Zoom percentage
Output & Format
format
query enum(png, jpeg, webp) Optional Example: png
Image format (`webmp` alias is accepted and normalized to `webp`)
height
query integer Optional Thumbnail height in pixels
width
query integer Optional Thumbnail width in pixels
Responses
200 Thumbnail image
▾
200 Thumbnail image
No JSON example provided in OpenAPI.
400 Invalid parameters
▾
400 Invalid parameters
{
"error": "Request validation failed",
"code": "VALIDATION_ERROR",
"fields": {
"url": [
"URL is required"
],
"country": [
"Country code must be ISO 3166-1 alpha-2"
]
}
} 401 Unauthorized
▾
401 Unauthorized
{
"success": false,
"error": "Invalid API key",
"code": "INVALID_API_KEY",
"details": {
"request_id": "req_123456"
}
} 404 Screenshot not found, not ready, or no image was captured
▾
404 Screenshot not found, not ready, or no image was captured
{
"success": false,
"error": "Invalid API key",
"code": "INVALID_API_KEY",
"details": {
"request_id": "req_123456"
}
} 500 Server error
▾
500 Server error
{
"success": false,
"error": "Invalid API key",
"code": "INVALID_API_KEY",
"details": {
"request_id": "req_123456"
}
}