Skip to main content
POST
Crawl Website

Authorizations

apikey
string
header
required

API Key (i.e. Rest API Key from the Dashboard).

Body

application/json

Website crawling configuration

url
string
required

Target website URL to crawl

Example:

"https://docs.example.com"

maxDepth
number
default:3

Maximum depth to crawl from the starting URL

Required range: 1 <= x <= 10
Example:

5

maxPages
number
default:100

Maximum number of pages to crawl

Required range: 1 <= x <= 10000
Example:

500

include
string[]

URL patterns to include in crawling (substring matching)

Example:
exclude
string[]

URL patterns to exclude from crawling (substring matching)

Example:
fetchSitemap
boolean
default:false

Fetch and return sitemap URLs from the website

Example:

true

Response

200 - application/json

Website scraped successfully

success
boolean
Example:

true

message
string
Example:

"Website scrape completed successfully"

data
object