About this endpoint
What it does
Captures a PNG screenshot of the URL you provide and returns the image as binary data. You can control the viewport size, how long the capture waits before taking the screenshot, and whether the capture should include the full page.
Query Parameter(s)
| Attribute | Type | Mandatory | Description |
|---|---|---|---|
| url | String | Yes | The URL to capture. |
| width | Integer | No | Viewport width in pixels.<br>Default: 1280.<br>Minimum: 320.<br>Maximum: 1920. |
| height | Integer | No | Viewport height in pixels.<br>Default: 800.<br>Minimum: 240.<br>Maximum: 1080. |
| wait_ms | Integer | No | Time to wait before capturing, in milliseconds.<br>Default: 1500.<br>Minimum: 0.<br>Maximum: 8000. |
| full_page | Boolean | No | Whether to capture the full page.<br>Default: true. |
Response
Returns a binary PNG image. The output schema is a top-level binary string, so the success response is the screenshot file itself rather than a JSON object.
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| value | String | Yes | Binary PNG screenshot data. |