Sign in

v9

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-01211389.1 KB

Batch content

Queue multiple web requests for later retrieval.

post/browser/batches

Request body

urlsstring[] required

The URLs of the pages to browse.

difficulty'low' | 'medium' | 'high'

The difficulty pool to attempt to access the URLs from.

speed'light' | 'ridiculous' | 'ludicrous (planned)'

The speed to attempt to access the URLs at, where ridiculous is 30 percent faster on average than light speed.

devicestring

The name as returned by the devices resource of the device to emulate browsing on (these names are case insensitive); device emulation is unused by default.

countrystring

The two-letter ISO code of the country to browse from (these codes are case insensitive); a random country is used by default.

subdivisionstring

The alphanumeric second part (proceeding the separator) of a first-level subdivision code in the (prerequisite) country to browse from (these codes are case insensitive); a random subdivision is used by default.

citystring

The commonly spelled name of the city in the (prerequisite) country to browse from (these names are temporarily case sensitive); a random city is used by default.

captcha'solved' | 'ignored' | 'rejected'

The intended resolution of any detected captcha, where rejected results in a 403 response.

readiness'load' | 'domcontentloaded'

The standard ready event to await before snapshotting browsed content.

delaynumber

The number of supplemental seconds to delay before snapshotting browsed content; no delay is used by default.

format'rendered' | 'raw' | 'markdown'

The format to output to.

expirationinteger

The age in days of when to consider cached content expired, where 0 disables caching.

callbackstring

The HTTP or HTTPS callback URL or Amazon SQS queue URL or ARN to notify when the batch content has been retrieved; any SQS queue must grant sqs:SendMessage permission to the arn:aws:iam::180363035301:role/api-instance AWS principal.

Example request

{
  "urls": [
    "https://guitars.com/",
    "https://cartervintage.com/",
    "https://musiccityvintageguitars.com/",
    "[Additional URLs here]"
  ],
  "difficulty": "low",
  "speed": "light",
  "captcha": "rejected",
  "readiness": "load",
  "format": "markdown",
  "callback": "https://webhook.site/02e249f8-1faf-4fab-bcf5-78ce683e85a8"
}

Response

A job identifier and confirmation count.

idstring uuid required

The identifier to retrieve the batch content with.

countinteger required

The number of requests in the batch as confirmed by the API.

Example response

{
  "id": "a0482596-c2ad-445a-a435-727002156a20",
  "count": 37
}