Skip to main content
POST
Start a website crawl

Authorizations

Authorization
string
header
required

Server-side tenant-scoped credential created from Build > API Keys.

Body

application/json
url
string<uri>
required
crawlDepth
integer
default:2
Required range: 1 <= x <= 3
maxPages
integer
default:500
Required range: 1 <= x <= 500

Response

Success

jobId
string
status
enum<string>
Available options:
queued,
running,
completed,
failed
progress
object
chunks
integer
url
string
crawlDepth
integer
maxPages
integer
sourceId
string
error
object