Screenshot
docs/Utilities/Screenshot

Screenshot

Capture a full-page screenshot of any URL.

Screenshot

Capture a full-page screenshot of any URL and receive it as a base64-encoded PNG image. Useful for visual verification, thumbnail generation, change detection, and feeding visual context to multimodal LLMs.

POST/v1/screenshotx-api-key

Request body

urlstringrequired

The URL to screenshot. Must be a valid HTTP or HTTPS URL.

Response

urlstring

The URL that was screenshotted.

screenshotstring

The full-page screenshot as a base64-encoded PNG string.

mimeTypestring

The MIME type of the image. Always "image/png".

Code examples

Example response

json snippet{}json
{
  "url": "https://example.com",
  "screenshot": "iVBORw0KGgoAAAANSUhEUgAA...",
  "mimeType": "image/png"
}

The screenshot field contains the full base64-encoded PNG image. For a typical webpage, this is usually between 200 KB and 2 MB of base64 data. Decode it on the client side to get the raw PNG bytes.