---
title: "Screenshot Canvas"
method: POST
path: "/canvases/{canvas_ref}/screenshot"
tags: ["canvas-actions"]
---

# Screenshot Canvas

`POST /canvases/{canvas_ref}/screenshot`

## Request

- Base URL: `https://api.moda.app/v1`
- URL: `https://api.moda.app/v1/canvases/{canvas_ref}/screenshot`
- Auth: HTTP bearer

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.

## Path parameters

- `canvas_ref` string, required

## Headers

- `Moda-Version` '2026-04-12' | '2026-05-01'

## Request body

- CanvasScreenshotRequest
  - `page_ids` string[], nullable: Pages to capture. Omit for the current page. Max 3.
  - `pixel_ratio` integer

## Response `200`

Successful Response

- object

## Other responses

- `401`: Authentication required.
- `402`: Insufficient credits for a metered operation.
- `403`: Permission denied for this scope.
- `404`: Resource not found.
- `409`: Conflict (idempotency / resource state).
- `422`: Request validation failed.
- `429`: Rate limit exceeded.
- `500`: Internal error.

## Changes

- **2026-11-03** `9ac6a3abc0f8`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/moda/apis/moda-public-api/changes/canvases/:canvas_ref/screenshot/post.md)

---

[API](https://skmtc.dev/moda/apis/moda-public-api.md) - [All operations](https://skmtc.dev/moda/apis/moda-public-api/llms.txt) - [OpenAPI document](https://skmtc.dev/moda/apis/moda-public-api/revisions/9ac6a3abc0f8?raw)