Skip to content
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
33 lines (23 sloc) 1.2 KB

Screenshot API

This API is deprecated, please refer to the new RESTFul API instead.


The screenshot API can capture screenshots, get screenshots, or check whether a screenshot exists.


  • use (required): The name of the index.
  • login (optional): The login parameter. This becomes required once you create a user.
  • key (optional): The key parameter related to the login (api key). This becomes required once you create a user.
  • url (required): The URL parameter denotes the URL to be captured.
  • action (required): The action parameter is an ENUM field with the following options:
    • capture: Captures a screenshot of the given URL.
    • image: Gets an already-existing image of the indicated URL.
    • check: Checks whether the URL was already captured.


HTTP Request:


HTTP response:

    <entry key="Check">bfbe8b2187bdfcc8a1136486c68247e4b2.png</entry>
You can’t perform that action at this time.