Parameters

This page indexes every option the screenshot endpoint accepts. Each row gives the POST JSON path, the GET query name if there is one, the default and the limits, and links to the page that explains the option. Use the filter to find an option by name, by GET name or by a word such as pdf or timeout. It is part of the API documentation.

How the options fit together

Options are grouped by the job they do. A POST request nests them ("wait": {"timeout": 45}). A GET request uses one flat name per option (timeout=45), and only for the most common ones. The groups run in roughly this order when the browser renders your page:

request ──▶ preset ──▶ device ──▶ your values        (later wins)
                                      │
  1. load      url · html · markdown · network (headers, cookies, auth)
  2. emulate   viewport · browser (dark mode, locale, timezone, media)
  3. filter    block (ads, trackers, cookie banners, URL patterns)
  4. wait      wait (until, for_selector, delay, timeout)
  5. modify    page (scripts, styles, click, hide, remove)
  6. capture   capture (viewport, full_page, element, clip)
  7. encode    output (format, quality) · pdf
  8. deliver   cache · storage · account webhooks

Two rules follow from this order:

• Presets are defaults. preset: "og_card" sets a 1200×630 viewport and PNG output. Send "output": {"format": "webp"} with it and you get WebP. A device overrides the preset's viewport. Your own viewport values override both.
• Changes to the page happen after the wait. A click or an injected style runs once the page is ready, so the capture shows the result. If a cookie banner appears late, block it in block rather than hiding it in page.

Parameter groups

Every parameter

GET names are listed only where the GET endpoint accepts the option. A dash means POST only. Times are milliseconds unless the row says seconds.

Authentication parameters are not in this table: api_key on GET, and key_id, expires and signature for signed URLs. Network proxy and country routing are planned and documented on the network page.

GET or POST?

Both endpoints accept the same groups. The difference is how much you can say.

On GET, booleans count only as the literal word true (or false): block_ads=1 is ignored. hide and remove split on commas, so a selector that itself contains a comma needs POST.

Where to go next

• Task guides that combine these options: all guides, for example wait strategies and blocking ads and cookie banners.
• Validation errors name the parameter in error.param. See error codes.
• Defaults per preset: presets reference. Device sizes: devices reference.

Last verified 2026-10-15 against the API specification and the request parser.