v3

latestOpenAPI 3.0.12026-08-0678153248.4 KB

Start a crawl job

post/api/crawl

Request body

urlstring required
maxPagesinteger
followLinksboolean
ignoreSitemapboolean
excludePatternsstring[]
includePatternsstring[]

Example request

{
  "sessionOptions": {
    "proxyCity": "new york"
  }
}

Response

Crawl job started successfully

jobIdstring required