Skip to main content
POST
Capture a screenshot of a web page

Authorizations

X-API-Key
string
header
required

Company API key - scoped to a specific company. Generate from the Integrations page in your dashboard.

Body

application/json

Screenshot capture parameters

companyId
string
required

Company ID whose data credits are billed for the call

url
string
required

Full http(s) URL of the page to capture

fullPage
boolean

Capture the entire scrollable page (default true) or just the visible viewport (false)

Response

Saved screenshot with its public image URL

Captured screenshot, saved to the image library

imageId
string

Saved image ID — the screenshot also appears in the Images library

url
string

Public URL of the PNG

sourceUrl
string

The page that was captured

fullPage
boolean

Whether the full scrollable page was captured