Sign in

v1

latestOpenAPI 3.1.0MIT2026-07-26134154266.9 KB
Crawl

Start a new crawl

Start a new crawl for the given website datasource. Only one crawl can be active per datasource at a time.

post/crawl/{id}/crawl

Path parameters

idstring uuid required

The website datasource ID

Response

Default Response

idstring uuid required
datasource_idstring uuid required
statusstring required
started_atstring date-time nullable required
completed_atstring date-time nullable required
total_pagesnumber nullable required
completed_pagesnumber required
new_pagesnumber required
updated_pagesnumber required
removed_pagesnumber required
unchanged_pagesnumber required
error_messagestring nullable required
created_atstring date-time required
updated_atstring date-time required