Tasks

Stop a task

Stop the current turn. Saved queued messages continue after it stops. Outputs stay readable.

post/task/{task_id}/stop

Request

  • Base URL
    https://api.autumn.ai
  • URL
    https://api.autumn.ai/task/{task_id}/stop
  • Auth
    • API key in header X-API-Key
    • or HTTP bearer

Path parameters

task_idstring required

The task_id returned by POST /task or POST /task/start.

Example:8fab6f34

Response

Stop signal accepted for the current turn.

task_idstring required
namestring nullable
statusstring nullable

Legacy; use state and done. plan (idle, or finished), execute (working), accepted (queued), deleted.

phase'plan' | 'execute' nullable

Legacy; use state and done.

activitystring nullable

Legacy; use state and done. idle, queued, planning, executing or thinking. queued is waiting for a free slot and starts on its own. Finished is idle.

output_countinteger nullable
credits_usedinteger nullable
created_atstring nullable
updated_atstring nullable
poll_after_sinteger nullable

Seconds to wait before polling status again.

status_urlstring nullable
task_urlstring nullable

API resource URL, relative to the API server. Open the chat in the browser at https://platform.autumn.ai/?task={task_id}.

output_urlstring nullable
stream_urlstring nullable
statestring nullable

A2A lifecycle state: submitted, working, input-required, completed, canceled or failed.

doneboolean nullable

True for input-required, completed, canceled and failed.

stagestring nullable

Current stage while the task is active.

messagestring nullable

Latest public-facing task message.

answerstring nullable

Full saved assistant answer for a completed chat task without output rows.

progressobject nullable

Rows saved and optional target count.

elapsed_sinteger nullable

Elapsed seconds in the current or most recent run.

queue_positioninteger nullable

Place in line for a queued task, or null when not queued.

queued_countinteger

Pending queued follow-ups.

outcomestring nullable

Normalized completed outcome.

errorobject nullable

Public failure code and recovery guidance.

nextobject nullable

Suggested next action and API call.

versionstring nullable

Changes when public task status changes.

app_urlstring nullable

Open the task in the Autumn app.

Example response

{
  "task_id": "8fab6f34",
  "name": "Series A AI security companies",
  "status": "execute",
  "phase": "execute",
  "activity": "executing",
  "output_count": 10,
  "poll_after_s": 5,
  "status_url": "/task/8fab6f34/state",
  "task_url": "/task/8fab6f34",
  "output_url": "/task/8fab6f34/output",
  "stream_url": "/task/8fab6f34/stream",
  "queue": {
    "position": 3,
    "eta_s": 240
  }
}

Changes

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