v1
protected
task-definitions

Create Task Definition

Changed on

Save a task: the agent, what to ask it, and the parameters.

post/v1/workspaces/{workspace}/task-definitions/

Request

  • The document declares no server URL.
  • Auth
    HTTP bearer

Path parameters

workspacestring required

Slug of the workspace the request acts in

Request body

agent_idstring uuid required

UUID of the agent that runs the task.

descriptionstring required

What the agent is asked to do each time the task runs.

namestring required

What the saved task is called.

parametersobject

Task parameters every run of it starts with, as on a run.

Response

Successful Response

agent_idstring uuid required
created_atstring date-time required
created_bystring required
descriptionstring required
idstring uuid required
namestring required
parametersobject required
updated_atstring date-time required

Changes