Skip to main content
POST
Screenshot Canvas

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

canvas_ref
string
required

Body

application/json
page_ids
string[] | null

Pages to capture. Omit for the current page. Max 3.

pixel_ratio
integer
default:1
Required range: 1 <= x <= 4

Response

Successful Response

The response is of type Response Canvasactionsscreenshot · object.