Skip to main content
POST
Start crawling a site

Authorizations

Authorization
string
header
required

An API key, sent as Authorization: Bearer enc_…. A dashboard session cookie works on the same route.

Body

application/json
url
string
required

Where to start. A bare hostname is accepted and assumed to be https.

Example:

"https://example.com"

max_pages
integer
default:50

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.

Required range: 1 <= x <= 500
max_depth
integer
default:5

How far from the start to follow links. Depth is multiplicative, so raising it costs far more than raising max_pages.

Required range: 1 <= x <= 5
include
string[]

Path patterns to follow. Empty means everything not excluded. * matches anything but a slash, ** anything, ? one character.

Example:
exclude
string[]

Path patterns to skip. An exclude always beats an include, so "all of /docs except /docs/internal" says exactly that.

Example:
subdomains
boolean
default:false

Follow links onto subdomains of the starting host.

max_chars
integer

Cap the text kept per page. Zero uses the service default.

structured
boolean
default:false

Include each page's own machine-readable declarations: JSON-LD, OpenGraph, Twitter cards, microdata, feeds and contacts.

tables
boolean
default:false

Include the tables recovered from each page, as rows of cells.

Response

The crawl was accepted and has not been done yet.

success
boolean
message
string
result
object
Last modified on September 24, 2026