Capture asynchronously
Start an asynchronous capture and return a status URL immediately. Use the status URL to monitor progress and retrieve the result when ready. Optionally, Snapsnip can notify a webhook or deliver the result to a configured cloud-storage.
Authorizations
Authenticate with a Snapsnip API key using Authorization: Bearer <api-key>.
Body
Capture options with an optional webhook or cloud-storage delivery.
Request body for an asynchronous capture.
Primary render output selection. format is the public JSON discriminator.
- PNG
- JPEG
- WebP
- AVIF
- PDF
Input document loaded into the isolated capture page.
- URL
- HTML
- Markdown
One page mutation or wait executed before rendering.
- Add style
- Hide selector
- Evaluate
- Click
- Hover
- Press key
- Wait
Capture-layer request blocking policy.
Optional conservative page cleanup performed before explicit actions.
Automatic JavaScript-dialog response.
- Dismiss
- Accept
- Accept with prompt
Browser environment configured before loading the source.
Metadata fields collected after page preparation.
Navigation behavior for one capture request.
Lightweight headless-browser masking policy.
None on the request inherits browser defaults. This does not guarantee
evasion of automation detection or anti-bot systems.
disabled, hide_headless Page area rendered by a capture.
- Viewport
- Full page
- Element
- Clip
1 <= x <= 300Optional external destination for the completion result.
Omit this field to retrieve the result through the status and download endpoints.
- Webhook
- Cloud storage
Callbacks
POST{$request.body#/delivery/destination}captureEvent
Body
- Option 1
- Option 2
Webhook payload emitted after a successful asynchronous capture.
Details of the completed capture.
Webhook event name. Always capture.completed.
capture.completed Unique identifier for this webhook event.
Time at which the webhook event was created.
Response
Event accepted
Response
Capture accepted for asynchronous processing.
Receipt returned after an asynchronous capture is accepted.
Opaque identifier used to query and download this capture.
36Time at which the server accepted the request.
Initial lifecycle state of the capture.
queued, running, completed, failed, expired API path used to retrieve the latest capture status.