Start crawling a site
Returns as soon as the job exists. The crawl runs afterwards; read it back by id.
Authorizations
An API key, sent as Authorization: Bearer enc_…. A dashboard session cookie works on the same route.
Body
Where to start. A bare hostname is accepted and assumed to be https.
"https://example.com"
How many pages to read. Discovery may find many more, and the job reports both numbers so you can tell a budget that ran out from a site that ended.
1 <= x <= 500How far from the start to follow links. Depth is multiplicative, so raising it costs far more than raising max_pages.
1 <= x <= 5Path patterns to follow. Empty means everything not excluded. * matches anything but a slash, ** anything, ? one character.
Path patterns to skip. An exclude always beats an include, so "all of /docs except /docs/internal" says exactly that.
Follow links onto subdomains of the starting host.
Cap the text kept per page. Zero uses the service default.
Include each page's own machine-readable declarations: JSON-LD, OpenGraph, Twitter cards, microdata, feeds and contacts.
Include the tables recovered from each page, as rows of cells.