URL Options

Configure how RenderScreenshot loads and captures the target URL.

Basic URL

The url parameter is required and specifies the page to capture.

{
  "url": "https://example.com/page"
}

Wait Options

Control when the screenshot is captured after the page loads.

Wait Until

{
  "url": "https://example.com",
  "wait": {
    "until": "networkidle"
  }
}
Value Description
load Wait for the load event (default)
domcontentloaded Wait for DOMContentLoaded event
networkidle Wait until network is idle

Wait for Selector

{
  "url": "https://example.com",
  "wait": {
    "selector": "#main-content"
  }
}

Block Options

Block ads, cookie banners, and other unwanted elements:

{
  "url": "https://example.com",
  "block": {
    "ads": true,
    "cookie_banners": true
  }
}

Was this page helpful?