Skip to main content
POST
/
batch
/
scrape
Batch Scrape
curl --request POST \
  --url https://api.blat.ai/batch/scrape \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "urls": [
    "https://example.com"
  ],
  "allow_external_links": false,
  "allow_subdomain_links": false,
  "extract_links": false,
  "format": "html",
  "webhook": {
    "url": "https://example.com/scrape_hook",
    "events": [
      "data"
    ],
    "headers": {},
    "metadata": {}
  }
}
'
{
  "batch_id": "batch_id"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Batch scraping request parameters

​
urls
string[]
required

List of URLs to scrape

Example:
["https://example.com"]
​
allow_external_links
boolean
default:false

Whether to include external links

​
allow_subdomain_links
boolean
default:false

Whether to include subdomain links

​
extract_links
boolean
default:false

Whether to extract links from HTML

​
format
enum<string>
default:html

The desired output format

Available options:
html,
markdown
​
webhook
object

Optional webhook configuration

Response

OK

​
batch_id
string

The ID of the batch scrape. Used to check the status of the batch later.