Skip to main content

DELETE /v1/crawl/

Cancel a crawl job that is currently in progress.

Authentication

This endpoint requires authentication using a Bearer token. Include your API key in the Authorization header:

Path Parameters

string
required
The ID of the crawl job to cancel (UUID format)

Response

string
The status after cancellation. Will be cancelled on successful cancellation.

Example Request

Example Response

Error Responses

This error occurs when:
  • The crawl ID doesn’t exist
  • The crawl belongs to a different account
  • The crawl has already completed or been deleted

Important Notes

  • Cancelling a crawl will stop it immediately, and you’ll only be charged for pages that were already crawled
  • You can still retrieve partial results from a cancelled crawl using the Get Crawl Status endpoint
  • Once cancelled, a crawl cannot be resumed - you’ll need to start a new crawl job
  • Cancelled crawls will have their status set to cancelled instead of completed or failed