Response Formats

RenderScreenshot returns screenshots in various formats based on your request parameters.

Image Formats

PNG (Default)

Content-Type: image/png

PNG is the default format. It's lossless and supports transparency.

{
  "url": "https://example.com",
  "output": {
    "format": "png"
  }
}

JPEG

Content-Type: image/jpeg

JPEG produces smaller files but doesn't support transparency.

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

WebP

Content-Type: image/webp

WebP offers the best compression with quality comparable to PNG.

{
  "output": {
    "format": "webp",
    "quality": 90
  }
}

PDF Output

Content-Type: application/pdf

Generate PDF documents from web pages:

{
  "url": "https://example.com",
  "output": {
    "format": "pdf"
  }
}

JSON Metadata

Request metadata instead of the image:

{
  "url": "https://example.com",
  "output": {
    "metadata_only": true
  }
}

Response:

{
  "url": "https://example.com",
  "screenshot_url": "https://cdn.renderscreenshot.com/...",
  "width": 1200,
  "height": 630,
  "format": "png",
  "size_bytes": 245632,
  "cached": true,
  "rendered_at": "2025-01-15T10:30:00Z"
}