Screenshot API

This document describes our "capture a screenshot of a URL/webpage" functionality (API endpoint), its associated HTTP header options, and possible error responses. See example usage here or scroll down.

Endpoint: service.headless-render-api.com

Screenshot Path: /screenshot/$URL

Example URL: 

https://service.headless-render-api.com/screenshot/https://example.com/

The target $URL is obviously part of the path, but do not re-encode or re-escape it beyond what you'd enter into a browser URL field. Both UTF-8 encoding and percent-encoding are acceptable.

Related links: 

• examples of using the Screenshot API
• clients
  • Node.js client
  • /.well-known/open-api.yaml for OpenAPI/Swagger
  • /.well-known/ai-plugin.json for LLMs like ChatGPT

A webpage screenshot API. Try it in your browser: service.headless-render-api.com/screenshot/https://example.com

curl https://service.headless-render-api.com/screenshot/https://example.com/ > out.png

// npm install prerendercloud
await prerendercloud.screenshot("https://example.com/", {
  deviceWidth: 800,
  deviceHeight: 600,
  viewportWidth: 640,
  viewportHeight: 480,
  viewportX: 0,
  viewportY: 0,
  format: "webp", // Default: png, other options: webp, jpeg
  // viewportQuerySelector: "#open-graph-div",
  // viewportQuerySelectorPadding: 10,
  // emulatedMedia: "screen",
  // viewportScale: 2, // Default: 1, min: 0.1, max: 3.0
  // isMobile: false, // Default: false, whether the meta viewport tag is taken into account
});