v1

latestOpenAPI 3.1.02026-08-0421263172.4 KB
tasks

Update task status

Updates the status of a Task as it progresses through its lifecycle.

This method allows agents or operators to report the current state of a task, which could include changes to task status, and error information.

Each status update increments the task's status_version. When updating status, clients must provide the current version to ensure consistency. The system rejects updates with mismatched versions to prevent race conditions.

Terminal states (STATUS_DONE_OK and STATUS_DONE_NOT_OK) are permanent; once a task reaches these states, no further updates are allowed.

put/api/v1/tasks/{taskId}/status

Path parameters

taskIdstring required

ID of task to update status of

Headers

Authorizationstring required

Bearer authentication

Request body

statusVersioninteger

The status version of the task to update. This version number increments to indicate the task's current stage in its status lifecycle. Specifically, whenever a task's status updates, the status version increments by one. Any status updates received with a lower status version number than what is known are considered stale and ignored.

Response

Task status update was successful

displayNamestring

DEPRECATED: Human readable display name for this task, should be short (<100 chars).

lastUpdateTimestring date-time

Records the time of last update.

scheduledTimestring date-time

If the task has been scheduled to execute, what time it should execute at.

descriptionstring

Longer, free form human readable description of this task

isExecutedElsewhereboolean

If set, execution of this task is managed elsewhere, not by Task Manager. In other words, task manager will not attempt to update the assigned agent with execution instructions.

createTimestring date-time

Time of task creation.