← Back to API index
GET /screenshot/thumbnail

Retrieve thumbnail image

Options

Options are grouped for easier scanning, similar to parameter-focused docs.

App

bottom

query integer Optional

Example: 0

Bottom crop edge in pixels

filename

query string Optional

Optional filename for Content-Disposition attachment

id

query integer Required

Screenshot ID

left

query integer Optional

Example: 0

Left crop edge in pixels

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

Right crop edge in pixels

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

Top crop edge in pixels

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

No JSON example provided in OpenAPI.

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

{
  "success": false,
  "error": "Invalid API key",
  "code": "INVALID_API_KEY",
  "details": {
    "request_id": "req_123456"
  }
}
404

Screenshot not found or not ready

{
  "success": false,
  "error": "Invalid API key",
  "code": "INVALID_API_KEY",
  "details": {
    "request_id": "req_123456"
  }
}
500

Server error

{
  "success": false,
  "error": "Invalid API key",
  "code": "INVALID_API_KEY",
  "details": {
    "request_id": "req_123456"
  }
}