Skip to main content
POST
Screenshot webpage

Description

This endpoint captures a screenshot of a specified URL, with options to customize the viewport, block cookie banners, set a wait time before capturing, and more.

Endpoint

Headers

  • Content-Type: application/json
  • Authorization: Bearer <API_KEY> (required)

Request Body

Responses

Success (200)

Returns the screenshot data and related information.
  • Content-Type: application/json
  • X-RateLimit-Limit: The rate limit for the user.
  • X-RateLimit-Remaining: The remaining number of requests for the user.

Bad Request (400)

Returned if the request is invalid.

Internal Server Error (500)

Returned if there’s an error during the screenshot process.

Example Request

Example Response

Notes

  • The viewport width must be less than or equal to 3840 pixels, and the height must be less than or equal to 10240 pixels.
  • The maximum wait time is 5000 milliseconds (5 seconds).
  • Credit usage:
    • Base cost: 20 credits
    • Additional 10 credits if autoScroll is true
    • Additional 10 credits if wait is set (any non-zero value)
  • If the URL doesn’t include a protocol, https:// will be used by default.
  • The clipRectangle option can only be used when fullPage is set to false.
  • Usage is recorded with detailed parameters for each request.
  • Events may be logged to PostHog for analytics purposes if enabled.

Rate Limiting

Rate limit headers (X-RateLimit-Limit and X-RateLimit-Remaining) are included in the response to indicate the user’s current rate limit status.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Options for capturing a screenshot of a webpage.

url
string<uri>
required

Fully-qualified URL to capture.

fullPage
boolean
default:false

Capture the entire scrollable page.

viewport
object

Browser viewport size in pixels.

clipRectangle
object

Clipping rectangle when capturing a partial screenshot.

Attempt to hide cookie banners before capturing the screenshot.

wait
integer
default:0

Delay in milliseconds before capturing, allowing the page to finish loading.

Required range: 0 <= x <= 5000
autoScroll
boolean
default:false

Scroll the page to trigger lazy-loaded content before capturing.

requestSource
enum<string>

Optional identifier describing where the API request originated.

Available options:
API,
WEB,
MAKE_DOT_COM,
ZAPIER,
N8N,
PLAYGROUND,
DEFAULT_AUTOMATION,
AGENT_PREVIEW,
AGENT_LIVE,
AUTOPILOT,
STUDIO

Response

Screenshot data returned.

screenshotUrl
string<uri>
required

Temporary download URL for the generated screenshot.