Cancel an owned active request or active structured-extraction run
data_cancel_requestCancels a pending, running, or CAPTCHA-solving page request. If the page is already completed, the endpoint can still cancel active dependent AI extraction runs without deleting the retained page result. Pending page cancellations attempt an immediate base-debit refund; running page cancellations are left for the existing refund-recovery flow. Requires scope 'scrape:write'. Returns {ok,status,data,meta}; API failures return {ok:false,status,error}.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"id": "<id>"
},
"name": "data_cancel_request"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | UUID of the target request or batch, as returned in the id field when it was created or listed. | |
| idempotency_key | No | Optional. Generate a unique value before a write and retain it for an exact-body retry; replay is free and a different body returns 409 IDEMPOTENCY_CONFLICT. |