Output Options

Configure the output format and quality of your screenshots.

Format

Choose the output format:

{
  "output": {
    "format": "png"
  }
}

Format	Content-Type	Description
`png`	`image/png`	Lossless, supports transparency (default)
`jpeg`	`image/jpeg`	Smaller file size, no transparency
`webp`	`image/webp`	Modern format, best compression
`pdf`	`application/pdf`	PDF document output (see PDF Options)

Quality

Set image quality for JPEG and WebP formats (1-100):

{
  "output": {
    "format": "jpeg",
    "quality": 85
  }
}

Full Page

Capture the entire scrollable page:

{
  "capture": {
    "mode": "full_page"
  }
}

Full-page capture is a capture option, not an output option. See capture options.

Transparent Background

output.transparent: true removes the default white page background, for PNG and WebP. It has no effect on JPEG. The page's own CSS background must also be transparent.

Resize

output.resize scales the captured image to a target size in the same request (POST only). The page is still laid out at the viewport size.

{
  "output": {
    "resize": { "width": 600, "height": 375, "fit": "cover" }
  }
}

width and height each accept 1 to 7680; send at least one. fit is contain (default), cover, fill, inside or outside. The image resize guide compares the modes.

Filename

output.filename sets the name in the Content-Disposition header. It is reduced to a base name of A-Z a-z 0-9 . _ - (other characters become _, max 100 characters), and the extension always matches the format, so "filename": "report" with format: "pdf" downloads as report.pdf.

Element Capture

Capture a specific element:

{
  "capture": {
    "selector": "#hero-section"
  }
}

A selector alone selects element mode. If the element is missing, the API falls back to a viewport capture unless capture.selector_required is true, in which case it fails with selector_not_found.

Clip Region

Capture a specific region:

{
  "capture": {
    "clip": {
      "x": 0,
      "y": 0,
      "width": 800,
      "height": 600
    }
  }
}