This Utility API lets you dynamically capture screenshots of websites that are accessible.
It lets you capture screenshots that can serve as a form of documentation, allowing users to capture a moment in time and refer back to it later for reference or analysis. This can save time by allowing users to quickly capture important information without having to manually copy and paste text or data. These can be used for marketing purposes, such as showcasing a product or service on a website or social media platform.
submit url: download file
The method lets you pass a url for a webpage and returns the generated image file as a parameter.
|The URL for the webpage you want to generate the screenshot
|The file name for the generated image. If no output attribute is provided, the default file name will be
|Time (in seconds) to wait before taking a screenshot of the webpage, especially useful when taking screenshots of Single Page Applications (SPA), default 3 seconds
|Quality of the screenshot - should be between 1 - 5 (5 being the highest quality). Defaults to highest quality
A successful request returns the generated image file.
HTTP Response Codes
The method may return one of the following HTTP status codes:
|The request was successful.
|Request is invalid or mandatory parameters are missing in the request.
|Required authentication information is either missing or not valid for the resource.
|There was an error in processing this request.
All requests to ApyHub services need to be authenticated, currently we support
basic authentication mechanisms.
You can generate and view your existing credentials from workspace settings (on the left side of the navbar) and go to applications.
Points to note:
- Credential secrets are generated on the fly and are not stored in plain text, so on generating a credential please save the secrets somewhere safe.
- Use the
apy-tokenas the header parameter to pass the token.
- Use the
Authorizationheader to send the basic authentication credentials.
To search for a specific error code, enter the code in the search box below. Alternatively, you can click on the button to view a complete list of all error codes.