GEgetaxonflow
Multi-Agent Planning

Cancel a pending plan

Cancel a plan that has not yet completed execution. Only plans with status pending or executing can be cancelled. Returns 409 if the plan is already completed or cancelled.

post/api/v1/plan/{id}/cancel

Request

Path parameters

idstring required

Plan ID to cancel

Request body

reasonstring

Optional cancellation reason

Example request

{
  "reason": "User requested cancellation"
}

Response

Plan cancelled successfully

successboolean
plan_idstring
status'cancelled'
messagestring

Human-readable summary of the cancel outcome (e.g. "Plan cancelled — 3 of 5 steps had already executed and were rolled back"). Useful for end-user UI; programmatic callers should prefer status.

Changes

No recorded changes to this operation across all 1 revision of this API.