{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "https://velox.dev/schema/methods/grabber.start.schema.json", "title": "grabber.start", "description": "Start a depth-limited crawl. Nothing is downloaded by this call: it only walks pages and collects candidate links, which the wizard then shows for selection. Privileged because an unbounded crawl is a resource commitment the browser must not be able to make on the user's behalf.", "x-privileged": true, "x-transports": [ "uds" ], "x-deadlineMs": 5000, "x-errors": [ -32003 ], "type": "object", "properties": { "params": { "type": "object", "additionalProperties": false, "required": [ "startUrl", "depth" ], "properties": { "startUrl": { "type": "string", "format": "uri" }, "depth": { "type": "integer", "minimum": 0, "maximum": 10 }, "includePatterns": { "type": [ "array", "null" ], "items": { "type": "string" } }, "excludePatterns": { "type": [ "array", "null" ], "items": { "type": "string" } }, "fileTypes": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "Extensions, without the dot. null means every type." }, "sameHostOnly": { "type": "boolean" }, "maxFiles": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 10000 }, "headers": { "oneOf": [ { "$ref": "https://velox.dev/schema/types/Headers.schema.json" }, { "type": "null" } ] }, "cookies": { "type": [ "array", "null" ], "items": { "$ref": "https://velox.dev/schema/types/Cookie.schema.json" } } } }, "result": { "type": "object", "additionalProperties": false, "required": [ "jobId" ], "properties": { "jobId": { "type": "string" } } } } }