Skip to main content
Version: v2

Browserless API Index

Browserless has production ready APIs that you can use depending on your use-case. Each API accepts different parameters and options; their schemas are displayed in the Open API page.

Browser APIs

The Browser APIs help you execute specific tasks for your use-case, and are available for both shared and enterprise users.

  • /content, to return HTML of dynamic content
  • /unblock, to return HTML, screenshots or cookies for protected sites
  • /download, return files Chrome has downloaded
  • /function, run HTTP requests without installing a library
  • /pdf, export a page as a PDF
  • /screenshot, capture a .png or .jpg
  • /scrape, return the structured JSON
  • /performance, run parallel Google Lighthouse tests

Management APIs

Enterprise customers can use the management APIs to access things like open sessions, metrics, and kill sessions among many more functions to monitor the health of their private deployments.

  • /sessions, gather information about currently running sessions
  • /metrics, give you information about your worker's configuration
  • /config, retrieve an array of session statistics with a maximum date of 1 week

Remember to check out all the APIs available from the Open API page