POST /plan-runs/:id/cancel

POST

/plan-runs/{id}/cancel

curl --request POST \
  --url https://example.com/plan-runs/example/cancel

Parameters

Path Parameters

id

required

string

Responses

200

Successful response.

Media typeapplication/json

object

planRun

required

object

id

required

string

planId

string | null

source

required

string

Allowed values: plan issues

projectId

required

string

agentName

required

string

promptTemplate

required

string

ref

string | null

providerOverride

string | null

modelOverride

string | null

maxCostUsd

number | null

dispatcherHandle

required

string

trigger

required

string

state

required

string

Allowed values: queued running succeeded failed cancelled

failureReason

string | null

createdAt

required

string

startedAt

string | null

endedAt

string | null

cancelledChild

required

object

childSeq

integer

runId

string

alreadyTerminal

required

boolean

Example

{
  "planRun": {
    "source": "plan",
    "state": "queued"
  }
}

default

Error response (see src/core/errors.ts).

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

hint

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "hint": "example"
  }
}