Scrola Logo

API Documentation

The Scrola API offers the simplest way to create full page screenshots using your favorite programming language.

Introduction

Welcome to the Scrola API documentation. Our goal is to make it extremely easy for software developers to create static or scrolling screetshots of their webpages. Our API allows you to create screenshots by simply providing your url, and tweaking a few parameters. We will do the rest!

Configuration

All requests made to the Scrola API require a valid API token and webhook URL. To gain access to the developer portal to provide your webhook url and access your API key, you must first create a Scrola account. If you are interested in trying out the video screenshots you can make, you can create a video using the dashboard, first, without using the API.

API tokens can be sent via the 'Authorization' header as follows:

curl https://api.scrola.app/v1/screenshot -H "Authorization: Bearer HqLyjWDarjtT1zdp7dc"

Screenshot Endpoint

  • urlstringrequired

    The web address of your desired screenshot, represented as a string.

  • viewport stringrequired

    The viewport of your screenshot,represented as a string. Allowed options are phone, tablet, and desktop.

Example request : (Node.js)

const endpoint = 'https://api.scrola.app/v1/screenshot'
const headers = { 'Authorization': 'Bearer HqLyjWDarjtT1zdp7dc' }
const data = { url: 'https://ibm.com', viewport: 'desktop' }
const request = await axios.post(endpoint, data, headers)

Example response :

{
  "ts": 1553658867173,
  "status": "processing"
}

Example webhook payload :

{
  "download": "https://api.editframe.com/renders/vKYlo2CkFVBOZG7/uTvKPCHuMOfqLGOf1wg4CaKBgJ",
  "size": 23523523,
  "status": "complete",
  "ts": 1553658874173
}

Video Endpoint

  • rate stringrequired

    The speed of your video screenshot,represented as a string. Allowed options are normal and fast.

  • urlstringrequired

    The web address of your desired screenshot, represented as a string.

  • viewport stringrequired

    The viewport of your screenshot,represented as a string. Allowed options are phone, tablet, and desktop.

Example request : (Node.js)

const endpoint = 'https://api.scrola.app/v1/video'
const headers = { 'Authorization': 'Bearer HqLyjWDarjtT1zdp7dc' }
const data = { rate: 'fast', url: 'https://ibm.com', viewport: 'desktop' }
const request = await axios.post(endpoint, data, headers)

Example response :

{
  "ts": 1553658867173,
  "status": "processing"
}

Example webhook payload :

{
  "download": "https://api.editframe.com/renders/vKYlo2CkFVBOZG7/uTvKPCHuMOfqLGOf1wg4CaKBgJ",
  "size": 23523523,
  "status": "complete",
  "ts": 1553658874173
}