Skip to main content
POST
Submit a host-aware render batch

Authorizations

Authorization
string
header
required

Customer API key from the Scrinly dashboard.

Body

application/json
urls
string<uri>[]
required
Required array length: 1 - 100 elements
Maximum string length: 2048
Pattern: ^https?://
url
string<uri>
Maximum string length: 2048
Pattern: ^https?://
timeout
integer
default:30
Required range: 10 <= x <= 60
waitUntil
enum<string>
default:networkidle2
Available options:
load,
domcontentloaded,
networkidle0,
networkidle2
width
integer
Required range: 100 <= x <= 3840
height
integer
Required range: 100 <= x <= 2160
device
string

Supported device preset; overrides width and height.

theme
enum<string>
default:light
Available options:
light,
dark
blockAds
boolean
default:true
blockChatWidgets
boolean
default:true
blockPopups
boolean
default:true
blockAccessibilityWidgets
boolean
default:true
hideSelectors
string[]
Minimum string length: 1
clickSelectors
string[]
Minimum string length: 1
scrollToElement
string
Minimum string length: 1
headers
object
write-only
cookies
object[]
write-only
priority
enum<string>
default:normal
Available options:
low,
normal,
high
cache
boolean
default:false
webhookUrl
string<uri>
Maximum string length: 2048
Pattern: ^https?://
webhookSecret
string
write-only
store
boolean
default:false
storage_provider
enum<string>
Available options:
b2,
s3,
r2
storage_path
string
storage_bucket
string
storage_endpoint
string<uri>
storage_region
string
default:auto
storage_access_key_id
string
write-only
storage_secret_access_key
string
write-only
storage_public_domain
string<uri>
storage_return_location
boolean
screenshot
boolean
default:false
format
enum<string>
default:jpg
Available options:
jpg,
png
extractMarkdown
boolean
extractHtml
boolean
extractStructure
boolean

Response

Per-item batch acceptance or validation results.

success
boolean
required
results
object[]
required
credits
object