Skip to main content
POST
Screenshot Website

Authorizations

Authorization
string
header
required

API key from Settings > Developer > REST API

Headers

Moda-Version
enum<string>
default:2026-05-01

Calendar-dated API version pin. New integrations should pin 2026-05-01 to opt into the newest response shapes. For back-compat the server also accepts requests with no header and resolves them to the current default (today: 2026-04-12); that default advances on each sunset date. Any unsupported value returns 400 unsupported_version.

Available options:
2026-04-12,
2026-05-01
Example:

"2026-05-01"

Path Parameters

website_id
string<uuid>
required

Body

application/json
paths
string[]

Page route paths to capture (default: the homepage). At most 3 per call.

Required array length: 1 - 3 elements
Required string length: 1 - 500
Pattern: ^\S+$
viewport
enum<string>
default:desktop

Viewport to render at (desktop=1440, tablet=768, mobile=375 CSS px wide).

Available options:
desktop,
tablet,
mobile
format
enum<string>
default:jpg

Image encoding of the captures.

Available options:
jpg,
png
scale
integer | null

Device scale factor (default 2; a capture over the pixel budget steps down automatically).

Required range: 1 <= x <= 2

Response

Successful Response

The response is of type Response Websitesscreenshot · object.