Skip to main content
DELETE
/
v1
/
crawl
/
{execution_id}
cURL
curl -X DELETE "https://api.getcatalog.ai/v1/crawl/crawl-skims-com-a1b2c3d4" \
  -H "x-api-key: $CATALOG_API_KEY"

{
  "status": "canceled",
  "execution_id": "crawl-skims-com-a1b2c3d4",
  "stop_date": "2025-01-15T10:35:22.000Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.getcatalog.ai/llms.txt

Use this file to discover all available pages before exploring further.

When to use: Use this endpoint when you need to stop a crawl that is currently running. This is useful if:
  • You started a crawl by mistake
  • The crawl is taking longer than expected and you want to stop it
  • You need to free up resources for other operations
Cancellation Requirements: You can only cancel executions that are currently running. If an execution has already completed or failed, it cannot be canceled. The endpoint will return an error if you attempt to cancel a non-running execution.

​
Request

​
x-api-key
string
required
Your API key for authentication
​
execution_id
string
required
The execution ID of the crawl to cancelFormat: crawl-{hostname}-{uuid}Note: If the execution ID does not exist, the endpoint returns a 404 Not Found error.

​
Response

​
status
string
Status after cancellation. Always "canceled" on success.
​
execution_id
string
The execution identifier that was canceled
​
stop_date
string | null
ISO 8601 timestamp when the execution was stopped (null if not available)
cURL
curl -X DELETE "https://api.getcatalog.ai/v1/crawl/crawl-skims-com-a1b2c3d4" \
  -H "x-api-key: $CATALOG_API_KEY"

{
  "status": "canceled",
  "execution_id": "crawl-skims-com-a1b2c3d4",
  "stop_date": "2025-01-15T10:35:22.000Z"
}