Capture a page snapshot
Extracts metadata and selected page content. blueprint=true is synchronous, implies design extraction, and cannot be combined with async or webhook delivery. The legacy api_key query credential is discouraged because URLs can leak through logs, browser history, proxies, and analytics.
Authorizations
Customer API key from the Scrinly dashboard.
Headers
Ephemeral server-to-server key for the selected AI provider. Never put it in a URL or JSON body.
Query Parameters
2048^https?://Return a reconstruction blueprint: labelled page regions carrying the motion, repeating components and generated stylesheets needed to rebuild the page. Implies design=true, requires synchronous mode, and refuses async or webhook delivery. Adds 6 credits.
Comma-separated viewports to capture, widest first — the first is the one regions and skeletons are measured from. Only valid with blueprint=true; rejected otherwise rather than ignored.
^(desktop|mobile)(,(desktop|mobile))*$Store one screenshot per viewport, taken in the page session the capture already opened. Set false to run a blueprint with no storage bucket configured. Only valid with blueprint=true.
Have a model read the blueprint back as a grounded Markdown document. Requires blueprint=true. Only a sanitised projection of the blueprint is sent to the provider: page copy, selectors and URLs are removed first. Adds 3 credits, or 1 with your own provider key.
deepseek, openai Bypass the interpretation cache and regenerate the document. The capture always runs.
10 <= x <= 60Response
Snapshot, optionally carrying a blueprint and its interpretation. blueprint_only reports a capture that succeeded with a failed interpretation.
2048^https?://x >= 0blueprint_only means the capture succeeded and the interpretation did not — see blueprint.interpretationError. The blueprint is present and its credits are not refunded.
completed, blueprint_only Deterministic extraction of authored tokens and observed design signals.
Everything needed to rebuild the page, attributed to the parts of the page it belongs to. Motion and responsive layout are filed under regions rather than listed flat, so "what does the hero do" is answerable. url, metadata, markdown, links, images and design are not restated here — they are already top-level fields of the same response.
