Loading
Loading
Capture screenshots of up to 50 URLs in a single POST request. Each URL can have its own screenshot settings — format, dimensions, CSS/JS injection, ad blocking, and more. Returns individual screenshot URLs per submitted URL.
Send a JSON body with a urls array. Each item in the array is an object containing a url and any optional screenshot parameters (same options as the single Screenshot API). The API key is passed via the X-apiKey header.
Pass your API key as the X-apiKey parameter in every request.
This is version v1.0 of the API.
The request body must be a JSON object containing a urls array. Each item is an object with a url field and optional screenshot parameters.
{
"urls": [
{
"url": "https://github.com",
"file_type": "png",
"width": 1280,
"height": 800
}
]
}A successful request returns a 200 OK with a JSON object containing a status string, metadata summary, and a results array with one entry per submitted URL.
statusRequest status indicator. 'success' for successful requests.
meta_dataSummary information about the bulk screenshot request.
resultsArray of per-URL screenshot results.
Summary counts for the bulk request:
total_urlsTotal number of URLs processed in the request.
successful_urlsNumber of URLs that were successfully processed.
failed_urlsNumber of URLs that failed to process.
Each item in the results array represents one submitted URL:
urlScreenshot response object for this URL. Same structure as the single Screenshot API response.
statusProcessing status of the individual URL. 'fulfilled' or 'rejected'.
error_messageError message if processing failed. null if successful.
The screenshot output object for the URL — same structure as the single Screenshot API response:
screenshotURL of the captured screenshot or video file.
urlThe original URL that was processed.
created_atISO 8601 timestamp when the screenshot was created.
formatOutput format type ('json' or 'image').
ttlISO 8601 expiry timestamp for the screenshot.
sizesDimensions used for multiple scrolling captures. Null if not used.
extracted_htmlURL of extracted HTML file. Present when extract_html=true.
[param_name]Any request parameter passed with non-default value is echoed back in the response.
The API uses standard HTTP status codes to indicate the success or failure of requests. For common status codes like 429 (Too Many Requests), refer to the general API documentation.
Please provide data in required format in request body
Maximum request body size limit exceeded