POST
/
v4
/
crawl
Start a new crawling session
curl --request POST \
  --url https://api.kadoa.com/v4/crawl \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "url": "<string>",
  "pathsFilterIn": [
    "<string>"
  ],
  "pathsFilterOut": [
    "<string>"
  ],
  "timeout": "1800000 - default 30 minutes",
  "maxDepth": 10,
  "maxPages": 1000,
  "strictDomain": true,
  "proxyCountry": "DE"
}'
{
  "message": "Session started",
  "sessionId": "<string>",
  "error": "<string>"
}

Authorizations

​
x-api-key
string
header
required

API key for authentication

Headers

​
x-api-key
string
required

API key for authentication

Body

application/json

Response

Crawling session started successfully

The response is of type object.