v1

latestOpenAPI 3.1.02026-08-0421263172.4 KB
tasks

Create task

Creates a new Task in the system with the specified parameters.

This method initiates a new task with a unique ID (either provided or auto-generated), sets the initial task state to STATUS_CREATED, and establishes task ownership. The task can be assigned to a specific agent through the Relations field.

Once created, a task enters the lifecycle workflow and can be tracked, updated, and managed through other Tasks API endpoints.

post/api/v1/tasks

Headers

Authorizationstring required

Bearer authentication

Request body

taskIdstring

If non-empty, will set the requested Task ID, otherwise will generate a new random GUID. Will reject if supplied Task ID does not match [A-Za-z0-9_-.]{5,36}.

displayNamestring

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

descriptionstring

Longer, free form human readable description of this Task.

isExecutedElsewhereboolean

If set, then the service will not trigger execution of this task on an agent. Useful for when ingesting tasks from an external system that is triggering execution of tasks on agents.

Response

Task creation 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.