Cancel Task

Changed on

Cancel a task and cascade to all of its descendant subtasks.

Walks the subtask tree (parent_task_id references) via TaskStore.cancel_cascade so that children are not left running after the parent is aborted. Returns the root task.

post/tasks/{task_id}/cancel

Request

  • The document declares no server URL.
  • Auth
    none declared

Path parameters

task_idstring required

Query parameters

stop_mode'immediate' | 'request' | 'confirm'

Request body

reasonstring

Response

Successful Response

idstring required
titlestring required
descriptionstring required
rolestring required
tenant_idstring required
priorityinteger required
scopestring required
complexitystring required
eu_ai_act_riskstring required
approval_requiredboolean required
risk_levelstring required
estimated_minutesinteger nullable required
statusstring required
depends_onstring[] required
parent_task_idstring nullable required
depends_on_repostring nullable required
owned_filesstring[] required
assigned_agentstring nullable required
result_summarystring nullable required
cell_idstring nullable required
repostring nullable required
task_typestring required
upgrade_detailsobject nullable required
modelstring nullable required
effortstring nullable required
clistring nullable
batch_eligibleboolean
completion_signalsobject[]
slack_contextobject nullable
metadataobject
created_atnumber required
claimed_atnumber nullable
completed_atnumber nullable
closed_atnumber nullable
deadlinenumber nullable
versioninteger
parent_session_idstring nullable
retry_countinteger
max_retriesinteger
retry_delay_snumber
terminal_reasonstring nullable
max_output_tokensinteger nullable
meta_messagesstring[]
max_turnsinteger nullable
artifact_specobject nullable

Changes