screenshotbuddy.com logo

Getting started

Last updated: 8 Mar 2025

How it works

Basically there are two ways to create screenshot by calling our Screenshot API

  1. Using Render links, this API call will generate an image URL that can be used directly in an img tag.
  2. Using screenshot render queue REST API endpoint. This method will generate a requestId and provide with a Status URL, that gives information about the screenshot lifecycle.

Requirements

Before you start using our API, you need to create an account and visit dashboard, where you will find following.

  1. API Key
  2. API Secret
  3. Access Token

We provide an extremely generous free tier, which offers up to 3000 Free Screenshot API calls per month. Create an account and start using our screenshot API for free.

Lets make your first API Request

* we are not using apiSecret in the example above, but this is just for the demo, screenshot creation with this method in production is not recommended, the screenshot created with this method will have a full tiled watermark.

Lets break down the example URL, In above example we are using 3 options

  1. accessToken. ( replace this with your own token , find it from dashboard)
  2. URL of the webpage we want to create screenshot of 'https://www.wikipedia.org/
  3. Format of the screenshot file generated by this request is png

Now you can copy paste this URL into a browser and you will have the screenshot of the URL, You can add many more screenshot options to customize the screenshot as per your need. Find all available and upcoming options here.

Documentation