Skip to main content

Endpoint

Capture up to 50 URLs in a single request. Each URL is processed as a separate screenshot job using a background queue.

Headers

Request body

urls
array
required
Array of URLs to capture (1–50 URLs). Each must be a valid URL.
options
object
Shared capture options applied to all URLs. Accepts the same options as the capture endpoint (e.g., format, viewport_width, full_page).

Response

201 Created

Response fields

data
array
Array of screenshot records, one per URL.
count
number
Total number of URLs in the batch.
succeededCount
number
Number of screenshots successfully queued.
failedCount
number
Number of screenshots that failed to queue. Credits for failed captures are refunded automatically.
remainingCredits
number
Your remaining monthly screenshot credits after this batch.

Error responses

The API validates that you have enough monthly credits for the entire batch before processing. If you have 10 credits remaining and submit 15 URLs, the entire request will be rejected.

Examples

Basic batch capture

Batch with shared options

Polling for batch results

After submitting a batch, poll individual screenshot IDs to track completion: