Documentation Guide

Capture the mobile web

Use a predictable mobile viewport for responsive review, visual evidence, and regression checks.

HTTPS API api-screenshot.com/v1 Bearer auth · JSON requests · private artifacts
Private development preview The contract is documented for integration planning. Production API routes currently return HTTP 503 and no live keys are being issued. OpenAPI 3.1 →
Mobile preset

Start with the mobile preset

The mobile preset uses a 390 by 844 CSS-pixel viewport with a device scale factor of 2. It is a stable default for responsive checks rather than an emulation claim for a specific branded device.

Request body json
{
  "url": "https://example.com",
  "preset": "mobile",
  "full_page": true,
  "format": "png",
  "wait_until": "load"
}
Custom viewport

Use dimensions when the test requires them

Send viewport instead of preset when you need an exact responsive breakpoint. The two fields are mutually exclusive.

Custom responsive breakpoint json
{
  "url": "https://example.com",
  "viewport": {
    "width": 768,
    "height": 1024,
    "device_scale_factor": 1
  },
  "format": "webp",
  "quality": 86
}