Web
Web web Crawl Cancel API
Stop a background crawl and keep the pages already read. Call the Web web Crawl Cancel API for JSON. 0 credits per call.
POST
Stop a background crawl and keep the pages already read
Stop a background crawl and keep the pages already read.
Request
id is required.
Response
If successful, the response body contains the standard envelope.data contains id, status, total, completed, failed, creditsUsed and message.
The following example is a real response, truncated: each list shows one item and long strings are cut.
For every field, see the response schema on this page.
Billing
Each successful request consumes 0 credits, regardless of the number of items returned. Requests that fail, or that return no items, are not billed.Pagination
This method is not paginated. A single request returns the complete result.Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Cut every text value in the response to this many characters. A value that was cut ends with …, and a page whose text was cut has isTruncated set to true. A screenshot is never cut. Leave it out to get the full text.
Required range:
x >= 1Body
application/json
The id web.crawl.start returned.
Pattern:
^job_[A-Za-z0-9_-]{22}$