Sign in
Browser Tools

Capture webpage screenshot

Captures a screenshot of a specified webpage.

post/v1/screenshot

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.

{"stackTrail":"components:schemas:ScreenshotRequest:properties:region","oasType":"schema","type":"unknown","description":"The desired region for the action to be performed in"}
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

Changed in 5 of the 54 revisions of this API.96

  • 7b73b0d577921See the full diff
    • ▲

      request body became required

      request-body-became-required

  • 4985d7bcd32f2See the full diff
    • ○

      added the new optional request property projectId

      new-optional-request-property

    • ○

      added the optional property linkToDocs to the response with the 503 status

      response-optional-property-added

  • 97dcad9b050e11See the full diff
    • ▲

      the region request property type/format changed from string/ to /

      request-property-type-changed

    • ○

      the response property context/items/params became required for the status 503

      response-property-became-required

  • 9f3355d65c6c7See the full diff
    • ▲

      removed the enum value bom of the request property region

      request-property-enum-value-removed

    • ▲

      removed the enum value fra of the request property region

      request-property-enum-value-removed

    • ▲

      removed the enum value hkg of the request property region

      request-property-enum-value-removed

    • ▲

      removed the enum value iad of the request property region

      request-property-enum-value-removed

    • ▲

      removed the enum value lax of the request property region

      request-property-enum-value-removed

    • ▲

      removed the enum value ord of the request property region

      request-property-enum-value-removed

    • ▲

      removed the enum value scl of the request property region

      request-property-enum-value-removed

  • 15ffd3fc04f33See the full diff
    • ○

      added the new optional request property region

      new-optional-request-property

    • ○

      added the non-success response with the status 503

      response-non-success-status-added

    • ○

      removed the non-success response with the status 500

      response-non-success-status-removed