Sign in
Scrapers

Cancel scraper request

Cancels a queued or running scraper Request.

post/v1/requests/{request_id}/cancel

Path parameters

request_idstring required
Example:request_123

Scraper Request id. Context $.paths./v1/requests/{request_id}/cancel.post.parameters.0.

Response

Scraper request canceled.

requestIdstring required
canceledboolean required
status'queued' | 'running' | 'succeeded' | 'failed' | 'canceled' required
agentInstructionstring required

Example response

{
  "requestId": "request_123",
  "canceled": true,
  "status": "canceled",
  "agentInstruction": "Request canceled. Create a new scraper request when ready."
}

Changes

Changed in 2 of the 50 revisions of this API.25

  • c7b37eaf7c3824See the full diff
    • ▲

      removed the required property from the response with the status

      response-required-property-removed

    • ▲

      removed the required property from the response with the status

      response-required-property-removed

    • ○

      added the required property to the response with the status

      response-required-property-added

    • ○

      added the required property to the response with the status

      response-required-property-added

    • ○

      added the required property to the response with the status

      response-required-property-added

    • ○

      added the required property to the response with the status

      response-required-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 3985c6090c911See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 141 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog