canvas-actions
Screenshot Canvas
Render up to 3 pages; returns the raw artifact contract (pages[].dataURL).
format declares the actual image encoding of the data URLs (JPEG today,
quality 0.92 — chosen for payload size on a base64 transport), derived from
the artifact itself.
POST
Screenshot Canvas
Authorizations
API key from Settings > Developer > REST API
Headers
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
Body
application/json
Response
Successful Response
The response is of type Response Canvasactionsscreenshot · object.