API Reference

Screenshots

Capture screenshots of any URL with a single API call. Returns the image as binary data (PNG, JPEG, or WebP) or as base64 JSON depending on the Accept header. No session management required.

POST/v1/screenshot

Take a screenshot of a URL.

Parameters

Name	Type	Required	Default	Description
`url`	`string`	Yes	`—`	The URL to screenshot.
`fullPage`	`boolean`	No	`false`	Capture the full scrollable page instead of just the viewport.
`viewport`	`{ width, height }`	No	`{ 1920, 1080 }`	Viewport dimensions in pixels.
`quality`	`number`	No	`—`	JPEG/WebP quality (1-100). Only applies to jpeg and webp formats.
`format`	`"png" \| "jpeg" \| "webp"`	No	`"png"`	Image format.
`waitFor`	`string \| number`	No	`—`	CSS selector to wait for, or milliseconds to wait after page load.
`proxyUrl`	`string`	No	`—`	Proxy URL for this request.
`stealth`	`"none" \| "basic" \| "full"`	No	`"full"`	Anti-detection level.
`timeout`	`number`	No	`30000`	Navigation timeout in milliseconds.

Request Body

{
  "url": "https://example.com",
  "fullPage": true,
  "format": "png",
  "viewport": { "width": 1440, "height": 900 }
}

Response

By default, returns binary image data with the appropriate Content-Type header (image/png,image/jpeg, orimage/webp).

If the request includes Accept: application/json, returns a JSON object with the screenshot as a base64-encoded string:

{
  "screenshot": "<base64-encoded-image>",
  "format": "png"
}

# Save as file
curl -X POST https://api.browsefleet.com/v1/screenshot \
  -H "Content-Type: application/json" \
  -H "x-api-key: bf_your_api_key" \
  -d '{ "url": "https://example.com", "fullPage": true }' \
  --output screenshot.png

# Get as base64 JSON
curl -X POST https://api.browsefleet.com/v1/screenshot \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "x-api-key: bf_your_api_key" \
  -d '{ "url": "https://example.com" }'