About this endpoint
What it does
Captures a screenshot of the webpage at the provided URL and returns it as a streamed PNG download. The request is configured through query parameters for the target URL and optional capture settings.
Query Parameter(s)
| Attribute | Type | Mandatory | Description |
|---|---|---|---|
| url | String | Yes | The webpage URL to capture. Must be a valid URI. |
| delay | Integer | No | Delay before capture, in seconds. Default: 3. Minimum: 0, maximum: 10. |
| output | String | No | Output filename for the downloaded image. Default: output.png. |
| quality | Integer | No | Screenshot quality level. Default: 5. Minimum: 1, maximum: 5. |
Response
Returns a binary string representing the downloaded screenshot file as PNG content. The success response is a streamed file download, not a JSON object.
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| binary payload | String | Yes | PNG file content returned by the endpoint. |