GET
Get crawl status
Poll the status of a crawl job started with POST /crawl. Once completed, s3PresignedUrls provides download links for the result artifacts — see Delivery for the full set of ways to receive crawl results.

Path parameters

  • id (string, required): Crawl job ID returned by POST /crawl.

Responses

  • 200: id, status (scraping, completed, failed, cancelled), limit, total, completed, failed, pending, inFlight, createdAt, completedAt, duration, s3PresignedUrls (download links, once available), error (failure message when status is failed).
  • 404: Crawl job not found.
  • 503: Crawl result store unavailable.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Crawl job ID returned by POST /crawl.

Response

Crawl status and download links

id
string
required
status
enum<string>
required

Current state of a crawl job.

Available options:
scraping,
completed,
failed,
cancelled
limit
integer
required
total
integer
required

Total pages attempted so far.

completed
integer
required
failed
integer
required
pending
integer
required
inFlight
integer
required
createdAt
string
required

ISO 8601 timestamp the crawl started.

duration
number
required

Elapsed seconds since the crawl started.

completedAt
string | null
s3PresignedUrls
S3 Presigned Urls · object | null

Presigned download URLs for the crawl's result artifacts, once completed.

error
string | null

Failure message when status is failed.