POST
Capture synchronously

Authorizations

Authorization
string
header
required

Authenticate with a Snapsnip API key using Authorization: Bearer <api-key>.

Body

application/json

Capture configuration.

One isolated page-capture request.

output
PNG · object
required

Primary render output selection. format is the public JSON discriminator.

source
URL · object
required

Input document loaded into the isolated capture page.

actions
(Add style · object | Hide selector · object | Evaluate · object | Click · object | Hover · object | Press key · object | Wait · object)[]

One page mutation or wait executed before rendering.

blocking
null | object

Capture-layer request blocking policy.

cleanup
object

Optional conservative page cleanup performed before explicit actions.

dialog_policy
Dismiss · object

Automatic JavaScript-dialog response.

environment
object

Browser environment configured before loading the source.

metadata
object

Metadata fields collected after page preparation.

navigation
object

Navigation behavior for one capture request.

stealth
null | enum<string>

Lightweight headless-browser masking policy.

None on the request inherits browser defaults. This does not guarantee evasion of automation detection or anti-bot systems.

Available options:
disabled,
hide_headless
target
Viewport · object

Page area rendered by a capture.

timeout
integer<int64> | null
Required range: 1 <= x <= 90

Response

Capture bytes.

The response is of type file.