Skip to main content
POST
web.screenshot

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 address of the page.

fullPage
boolean

Capture the whole page instead of the first screen. Default false.

width
integer

Browser window width in pixels. Send it with height.

Required range: 320 <= x <= 2560
height
integer

Browser window height in pixels. Send it with width.

Required range: 200 <= x <= 2560

Response

The result

image
object
required

The picture, as a file on our storage.

url
string

Final address of the page.

title
string

Page title.