Skip to main content
GET
Capture a page snapshot

Authorizations

Authorization
string
header
required

Customer API key from the Scrinly dashboard.

Headers

X-Scrinly-Provider-API-Key
string
write-only

Ephemeral server-to-server key for the selected AI provider. Never put it in a URL or JSON body.

Query Parameters

url
string<uri>
required
Maximum string length: 2048
Pattern: ^https?://
markdown
boolean
default:false
html
boolean
default:false
images
boolean
default:false
videos
boolean
default:false
fonts
boolean
default:false
colors
boolean
default:false
structure
boolean
default:false
design
boolean
default:false
blueprint
boolean
default:false

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.

viewports
string
default:desktop,mobile

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.

Pattern: ^(desktop|mobile)(,(desktop|mobile))*$
screenshots
boolean
default:true

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.

interpret
boolean
default:false

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.

provider
enum<string>
default:deepseek
Available options:
deepseek,
openai
refresh
boolean
default:false

Bypass the interpretation cache and regenerate the document. The capture always runs.

async
boolean
default:false
timeout
integer
default:30
Required range: 10 <= x <= 60

Response

Snapshot, optionally carrying a blueprint and its interpretation. blueprint_only reports a capture that succeeded with a failed interpretation.

success
any
required
type
any
required
url
string<uri>
required
Maximum string length: 2048
Pattern: ^https?://
metadata
object
required
renderTime
integer
required
Required range: x >= 0
status
enum<string>

blueprint_only means the capture succeeded and the interpretation did not — see blueprint.interpretationError. The blueprint is present and its credits are not refunded.

Available options:
completed,
blueprint_only
markdown
string
html
string
images
string[]
videos
string[]
fonts
object[]
colors
object[]
structure
object
design
object

Deterministic extraction of authored tokens and observed design signals.

blueprint
object

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.

credits
object
startedAt
string<date-time>
completedAt
string<date-time>