Create

Create a new web crawl.

This endpoint expects an object.

urlstringRequiredformat: "uri">=1 character<=2083 characters

URL of the website to scan

knowledge_graphstring or nullOptionalformat: "uuid"

the id of the knowledge graph

scan_depthintegerOptional>=1<=3Defaults to 1

How deep to crawl. 1 for single page, >1 for recursive

max_pagesintegerOptional>=1<=300Defaults to 50

Maximum number of pages to crawl. Only applies when scan_depth > 1

Successful Response

idstringformat: "uuid"

createdstringformat: "date-time"

modifiedstringformat: "date-time"

urlstringformat: "uri">=1 character<=2083 characters

scan_depthinteger

How deep to crawl. 1 for single page, >1 for recursive

last_scan_datestringformat: "date-time"

statusstring or null

Human-readable status label

crawl_statsmap from strings to any or null

crawled_urlslist of any or null

website_metadatamap from strings to any or null

error_detailsstring or null

is_activeboolean or nullDefaults to true

1	curl -X POST https://api.flockx.io/api/v1/crawls \
2	-H "Authorization: <apiKey>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"url": "foo"
6	}'