Skip to main content
POST
Capture a full-page screenshot of a page

Body

application/json
session
string

Editor session key. Scoped with siteId into the key the state store uses.

siteId
string

Site this session belongs to, when the orchestrator hosts more than one.

slug
string

Defaults to the home page, /.

previewUrl
string

Override the preview URL from the registered site config.

draftPath
string

Override the draft-preview route — a prefix the slug is appended to (/avocado) or a template naming where the slug goes (/preview/{slug}/draft). Defaults to the registered site's draftPath, then /preview-draft.

published
boolean

Screenshot the published route instead of the draft preview. Defaults to false.

Response

200

The captured screenshot.