Skip to main content
POST
Start an asynchronous crawl

Authorizations

X-Web-Extract-Api-Key
string
header
required

API key. X-Api-Key and Bearer authentication are also accepted.

Body

application/json
url
string<uri>
required
limit
integer
default:100
maxDepth
integer
default:2
includeSubdomains
boolean
default:false
ignoreQueryParameters
boolean
default:true
timeout_seconds
integer
default:30
waitFor
integer
default:0
useBrowser
enum<string>
default:auto
Available options:
never,
auto,
always
maxRetries
integer
default:2

Response

Crawl job created.

id
string
url
string<uri>
status
string