Skip to main content
GET
Retrieve crawl status

Authorizations

Authorization
string
header
required

Server-side tenant-scoped credential created from Build > API Keys.

Path Parameters

jobId
string
required

Copy jobId from crawl creation result or list_knowledge_crawls; it belongs to the connected business. Do not derive it from a title, URL or external provider ID.

Response

Success

jobId
string
status
enum<string>
Available options:
queued,
running,
completed,
failed
progress
object
chunks
integer
url
string
crawlDepth
integer
maxPages
integer
sourceId
string
error
object
websiteId
string
Maximum string length: 128
websiteGenerationId
string
Maximum string length: 128
createdAt
string
Maximum string length: 128
startedAt
string
Maximum string length: 128
completedAt
string
Maximum string length: 128
updatedAt
string
Maximum string length: 128
snapshotPages
integer
Required range: x >= 0