Skip to content

Start crawling job

POST
/crawl

Authorizations

Request Body required

object
url
required

The URL to crawl.

string
itemsLimit
required

The limit on the number of items to return.

integer
cleanContent
required

Whether to clean the returned content.

boolean
webhookURL
required

The webhook URL to send the response to.

string
whitelistRegexp

Regular expression for whitelisting URLs.

string
blacklistRegexp

Regular expression for blacklisting URLs.

string

Responses

200

Successfully submitted the crawl job

object
jobId

Unique identifier for the crawl job.

string
message

Status message regarding the job submission.

string

400

Bad request due to invalid input

401

Unauthorized access

500

Internal server error