Screenshot Retrieve Endpoint

Swagger documentation:!/retrieve/retrieve

Endpoint for submitting a request to capture a URL:


Add your API key to the HTTP header in the apikey field.

Use this to retrieve a previously submitted screenshot capture request. There is no API cost for calling retrieve, you can call that as many times as you need to, though there is rate limiting on the API to prevent too many calls in a short period of time. Screenshots take around 8 seconds each to capture, and when multiple captures are submitted, they are queued and processed in parallel but depneding on current load they may not all be processed at once. If you are submitting a small number of requests then you can poll retrieve every 3 to 6 seconds to get the response. If you have submitted a large number of requests then it is recommended to wait a longer period before tries. Requests are processed FIFO, so if you have submitted a large number you may wish to poll status for the last item, at which time you will know that all prior items have completed as well.

Retrieve Request


Specify the RequestId, or key, to retrieve your screenshot. Use the key given from the response of the capture request here. This will check to see if the screenshot capture has completed. If it has completed it will

Retrieve Response

Pending Response

If the screenshot request is still pending, the response will be:

  "status": "processing"

Success Response

If the screenshot request has completed, the response will indicate where the screenshot image can be downloaded from:

  "status": "ready",
  "imageUrl": ""

Error Response

Or, if an error occurred:

  "status": "error",
  "errCode": "500",
  "msg": "Error from backend screenshot worker: 500"

Proper use of Image URLs

Note that the Amazon S3 URL given in the imageUrl field of the response is ephemeral and will expire within at most 72 hours. It is not the intention that you would use this URL in your website. Rather, your server side code should use this URL to one-time download the image and save it on your own server, or in your own S3 bucket, pointing your website to that location.