v2

latestOpenAPI 3.1.02026-07-2626392.1 KB

Start an asynchronous crawl job from a seed URL.

post/v1/crawl

Request body

urlstring uri required
formatsstring[]
only_main_contentboolean
wait_forinteger
timeoutinteger
max_pagesinteger
depthinteger
use_sitemapboolean
include_patternsstring[]
exclude_patternsstring[]
webhook_urlstring uri

Response

Successful response

idstring
status'queued' | 'running' | 'completed' | 'failed' | 'cancelled'