Browser Tools

Capture webpage screenshot

Changed on

Captures a screenshot of a specified webpage.

post/v1/screenshot

Request

  • Base URL
    https://api.steel.dev
  • URL
    https://api.steel.dev/v1/screenshot
  • Auth
    • API key in header steel-api-key
    • or none

Request body

delaynumber

Delay before capturing the screenshot (in milliseconds)

fullPageboolean

Capture the full page screenshot. Default is false.

projectIdstring uuid

Project to execute the screenshot in.

regionunknown
urlstring uri required

URL of the webpage to capture

useProxyboolean

Use a Steel-provided residential proxy for capturing the screenshot

Response

Default Response

urlstring uri required

URL where the screenshot is hosted

Changes