curl --request POST \
--url http://localhost:3500/v1/workflow-runs/{id}/cancel \
--header 'Authorization: Bearer <token>'const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('http://localhost:3500/v1/workflow-runs/{id}/cancel', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "http://localhost:3500/v1/workflow-runs/{id}/cancel"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text){
"id": "44444444-4444-4444-8444-444444444444",
"retry_of_run_id": null,
"type": "invoice_import",
"resource": {
"type": "invoice_import",
"id": "33333333-3333-4333-8333-333333333333"
},
"status": "cancelled",
"progress": {
"total": 1,
"queued": 0,
"running": 0,
"completed": 0,
"skipped": 0,
"failed": 0,
"cancelled": 1
},
"created_at": "2026-09-08T12:00:00.000Z",
"updated_at": "2026-09-08T12:00:30.000Z",
"started_at": "2026-09-08T12:00:02.000Z",
"finished_at": "2026-09-08T12:00:30.000Z",
"failure": null
}{
"error": {
"code": "validation_error",
"message": "Invalid request format, parameters, or body. Details contain up to 20 actionable field errors; the complete encoded request body must be at most 2 MiB (2,097,152 bytes).",
"request_id": "req_example"
}
}{
"error": {
"code": "invalid_token",
"message": "Missing or invalid bearer credential.",
"request_id": "req_example"
}
}{
"error": {
"code": "forbidden",
"message": "Access denied: forbidden, token_disabled, organization_required, insufficient_role, or mfa_required. Check the error code and effective permissions.",
"request_id": "req_example"
}
}{
"error": {
"code": "not_found",
"message": "The resource does not exist in the current organization.",
"request_id": "req_example"
}
}{
"error": {
"code": "conflict",
"message": "This run completed, failed, or was superseded and cannot be cancelled.",
"request_id": "req_example"
}
}{
"error": {
"code": "rate_limit_exceeded",
"message": "The IP or authenticated credential exceeded its request limit.",
"request_id": "req_example"
}
}{
"error": {
"code": "internal_error",
"message": "Unexpected server failure. Include the request ID when contacting support.",
"request_id": "req_example"
}
}{
"error": {
"code": "service_unavailable",
"message": "Authentication infrastructure is unavailable or rate limited. Honor Retry-After when provided.",
"request_id": "req_example"
}
}Cancel a workflow run
Cancels this exact execution through the owning domain. Product cancellation stops discovery, cancels pending items, and fences late publication before provider cancellation is requested. Results from already completed items are retained. Repeated cancellation succeeds, including after a new retry; an old run URL never cancels the newer run. Completed, completed_with_errors and failed runs return 409 and retain their result/failure. No request body or Idempotency-Key is needed.
curl --request POST \
--url http://localhost:3500/v1/workflow-runs/{id}/cancel \
--header 'Authorization: Bearer <token>'const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('http://localhost:3500/v1/workflow-runs/{id}/cancel', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "http://localhost:3500/v1/workflow-runs/{id}/cancel"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text){
"id": "44444444-4444-4444-8444-444444444444",
"retry_of_run_id": null,
"type": "invoice_import",
"resource": {
"type": "invoice_import",
"id": "33333333-3333-4333-8333-333333333333"
},
"status": "cancelled",
"progress": {
"total": 1,
"queued": 0,
"running": 0,
"completed": 0,
"skipped": 0,
"failed": 0,
"cancelled": 1
},
"created_at": "2026-09-08T12:00:00.000Z",
"updated_at": "2026-09-08T12:00:30.000Z",
"started_at": "2026-09-08T12:00:02.000Z",
"finished_at": "2026-09-08T12:00:30.000Z",
"failure": null
}{
"error": {
"code": "validation_error",
"message": "Invalid request format, parameters, or body. Details contain up to 20 actionable field errors; the complete encoded request body must be at most 2 MiB (2,097,152 bytes).",
"request_id": "req_example"
}
}{
"error": {
"code": "invalid_token",
"message": "Missing or invalid bearer credential.",
"request_id": "req_example"
}
}{
"error": {
"code": "forbidden",
"message": "Access denied: forbidden, token_disabled, organization_required, insufficient_role, or mfa_required. Check the error code and effective permissions.",
"request_id": "req_example"
}
}{
"error": {
"code": "not_found",
"message": "The resource does not exist in the current organization.",
"request_id": "req_example"
}
}{
"error": {
"code": "conflict",
"message": "This run completed, failed, or was superseded and cannot be cancelled.",
"request_id": "req_example"
}
}{
"error": {
"code": "rate_limit_exceeded",
"message": "The IP or authenticated credential exceeded its request limit.",
"request_id": "req_example"
}
}{
"error": {
"code": "internal_error",
"message": "Unexpected server failure. Include the request ID when contacting support.",
"request_id": "req_example"
}
}{
"error": {
"code": "service_unavailable",
"message": "Authentication infrastructure is unavailable or rate limited. Honor Retry-After when provided.",
"request_id": "req_example"
}
}Authorizations
Personal API key. Send X-Organization-Id. The required cumulative level is listed in x-watchdog-permission.
Headers
Required for personal API keys. Target one organization you have access to. Migrated keys may omit it to use their original organization. For Clerk sessions, it must match the active organization.
Path Parameters
Response
The cancelled operation, with already completed item results retained.
One operation containing zero or more work items. Explicit retry creates a new run.
organization_currency_conversion, document_extraction, agreement_document_classification, agreement_detail_suggestions, invoice_import, invoice_import_batch, invoice_agreement_matching, agreement_invoice_matching, invoice_compliance_check, agreement_compliance_check, integration_sync, alert_topic_reconciliation, alert_topic_proposal, agreement_context_suggestions, agreement_price_import The business operation owning this execution; for invoice_import, the InvoiceImport.
Show child attributes
Show child attributes
queued, running, completed, completed_with_errors, failed, cancelled Counts of admitted items. total is null while more items may be discovered.
Show child attributes
Show child attributes
Last product state change, excluding internal provider checks.
Show child attributes
Show child attributes