Skip to main content
POST
Create Task Definition

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

workspace
string
required

Slug of the workspace the request acts in

Maximum string length: 120
Pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$

Body

application/json

A saved task: the agent, what to ask it, and the parameters to ask with.

agent_id
string<uuid>
required

UUID of the agent that runs the task.

description
string
required

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

Required string length: 1 - 20000
name
string
required

What the saved task is called.

Required string length: 1 - 255
parameters
Parameters · object

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

Response

Successful Response

agent_id
string<uuid>
required
created_at
string<date-time>
required
created_by
string
required
description
string
required
id
string<uuid>
required
name
string
required
parameters
Parameters · object
required
updated_at
string<date-time>
required