Skip to main content
POST
web.render.html

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
url
string
required

Public http or https URL of the page to render.

waitMs
integer
default:0

Milliseconds to wait after loading, 0 to 5000. Default 0.

Required range: 0 <= x <= 5000
userAgent
string

Optional browser User-Agent header, at most 512 printable characters.

Required string length: 1 - 512
Pattern: ^[\x20-\x7e]+$

Response

The result

html
string
required

Rendered page HTML as inert text; may contain personal data. Limited to 1 MiB of UTF-8.

truncated
boolean
required

True when HTML was cut to fit the 1 MiB size cap.

blocked
boolean
required

True when recognized bot-challenge markup was detected before truncation; false does not guarantee access.

url
string

Final public page URL, present when the source reports it.

status
integer

Page HTTP status, present when the source reports it.

Required range: 100 <= x <= 599