Skip to main content
POST

Authorizations

​
Authorization
string
header
required

API key authentication. Get your API key at https://snapopa.com/dashboard

Body

application/json
​
url
string<uri>

URL to capture

Maximum string length: 2048
​
html
string

Raw or base64-encoded HTML to render. Mutually exclusive with url.

Maximum string length: 1048576
​
responseType
enum<string>
default:json

Return JSON metadata or the raw file.

Available options:
json,
file
​
format
enum<string>
default:jpeg

Output file format. One of: png, jpeg, webp, pdf.

Available options:
png,
jpeg,
webp,
pdf
​
responseCache
object

Reuse cached results to avoid duplicate captures.

​
viewport
object

Viewport dimensions.

​
colorScheme
enum<string>
default:light

Browser prefers-color-scheme value.

Available options:
light,
dark,
no-preference
​
quality
integer
default:85

Image quality for JPEG and WebP. Ignored for other formats.

Required range: 1 <= x <= 100
​
cdnTtl
integer
default:86400

CDN storage lifetime in seconds. Ignored when persistence is enabled.

Required range: 60 < x <= 2592000
​
isFullPage
boolean
default:false

Capture the full scrollable page. Overrides viewport height.

​
async
boolean
default:false

Process in the background and return immediately.

​
persistence
object

Long-term storage with optional auto-refresh.

​
timeout
integer
default:30000

Navigation timeout in milliseconds.

Required range: 5000 <= x <= 120000
​
waitUntil
enum<string>
default:domcontentloaded

Page load state to wait for before capturing.

Available options:
load,
domcontentloaded,
networkidle,
commit
​
imageLoadTimeout
integer
default:5000

Max time in milliseconds to wait for images to load. Returns early if all images load sooner.

Required range: 0 <= x <= 15000
​
delay
integer
default:0

Extra wait in milliseconds after page load before capturing. Useful for animations or delayed content.

Required range: 0 <= x <= 15000
​
region
enum<string>
default:auto

Geographic region for browser rendering.

Available options:
auto,
us-east,
us-west,
eu-west,
eu-central,
asia-east,
asia-southeast
​
antiBot
boolean
default:false

Use stealth providers to bypass bot detection.

​
block
object

Block ads, trackers, and media to speed up captures.

Response

Capture created successfully

​
success
enum<boolean>
required
Available options:
true
​
error
unknown
required
​
data
object
required