Skip to main content
POST
Start a crawl

Authorizations

Authorization
string
header
required

Customer API key from the Scrinly dashboard.

Body

application/json
url
string<uri>
required
Maximum string length: 2048
Pattern: ^https?://
maxPages
integer
default:50
Required range: 1 <= x <= 5000
maxDepth
integer
default:3
Required range: 0 <= x <= 10
maxConcurrentPages
integer
default:3
Required range: 1 <= x <= 10
maxDurationMs
integer
default:1800000
Required range: 1000 <= x <= 21600000
scope
enum<string>
default:origin
Available options:
origin,
host,
domain,
any
includePaths
string[]
excludePaths
string[]
followBinary
boolean
default:false
robots
enum<string>
default:obey
Available options:
obey,
ignore
markdown
boolean
default:true
html
boolean
default:false
structure
boolean
default:false
store
boolean
default:true
storage_path
string
default:crawls
query
enum<string>
default:normalise
Available options:
normalise,
strip,
keep
webhookUrl
string<uri>
Maximum string length: 2048
Pattern: ^https?://
webhookSecret
string
write-only

Response

Crawl accepted

success
any
required
id
string<uuid>
required
statusUrl
string
required
pagesUrl
string
required
resultsUrl
string
required