GET
/
api
/
crawl
/
{id}

Authorizations

​
x-api-key
string
headerrequired

Path Parameters

​
id
string
required

Query Parameters

​
page
integer
Required range: x > 0
​
batchSize
integer
Required range: x > 1

Response

200 - application/json
​
status
enum<string>
Available options:
pending,
running,
completed,
failed
​
data
object[]
​
error
string | null
​
totalCrawledPages
integer
Required range: x > 0
​
totalPageBatches
integer
Required range: x > 0
​
currentPageBatch
integer
Required range: x > 0
​
batchSize
integer
Required range: x > 1
Start a crawl job