Render Queue

Overview

This is an async method to request screenshots with our API, after you send a request the API creates a requestId adds the screenshot request in render queue and replys with a status URL. The render queue is processed evenly for all Free tier users, we have checks and balances in place to make sure no single user can abuse the system, Users of Paid plans run on altogether different infrastructure.

Using the status URL you can check the status of the request, after the request is completed the status URL response will provide you with screenshotUrl and screenshotHtmlUrl which you can use any way you find fit.

Screenshot Render Queue details

You will need an API Key for using render queue. In this method you have to send a POST request to our Render queue API endpoint with your API Key in an Authorization header and screenshot options in the request body. You will instantly get a JSON response with following keys.

• statusUrl
• status
• requestId

If you have not provided a force screenshot option, the API will re-use a recently created Screenshot and send you an immediate response with these extra keys. This way you will get an immediate access to screenshot.

• screenshotUrl
• screenshotHtmlUrl

Example code to create a screenshot render queue request