Skip to main content
POST
Queue stored screenshots

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
urls
string<uri>[]
required
Required array length: 1 - 100 elements
Pattern: ^https?://
screenshot
boolean
required
store
boolean
required
storage_path
string
required
Minimum string length: 1
format
enum<string>
default:jpg
Available options:
jpg,
png
quality
integer
default:80
Required range: 1 <= x <= 100
width
integer
Required range: 320 <= x <= 3840
height
integer
Required range: 240 <= x <= 2160
device
string
fullPage
boolean
default:false
theme
enum<string>
default:light
Available options:
light,
dark
timeout
integer
Required range: 10 <= x <= 60
waitUntil
enum<string>
Available options:
load,
domcontentloaded,
networkidle0,
networkidle2
hideSelectors
string[]
clickSelectors
string[]
scrollToElement
string
headers
object
write-only
cookies
object[]
write-only
webhookUrl
string<uri>
webhookSecret
string
write-only
storage_provider
enum<string>
Available options:
b2,
s3,
r2
storage_bucket
string
storage_endpoint
string<uri>
write-only
storage_access_key_id
string
write-only
storage_secret_access_key
string
write-only
storage_public_domain
string<uri>

Response

Per-item acceptance; 207 means partial acceptance.

success
boolean
required
total
integer
required
accepted
integer
required
failed
integer
required
results
object[]
required
credits
object