Sign in

v1

latestOpenAPI 3.1.02026-07-23310383.1 KB
Tasks

Retrieves multiple tasks.

get/api/v1/tasks

Query parameters

string[]
OR
string uuid

A UUID v4 string that identifies an entity.

pageNumbernumber

The page number.

The page number.

pageSizenumber

The page size.

The page size.

string[]
OR
string uuid

A UUID v4 string that identifies an entity.

Headers

authorizationstring required

The API key to use for authentication. Can be created in the api keys section on the workspace settings page.

The API key to use for authentication. Can be created in the api keys section on the workspace settings page.

Response

Retrieves all tasks for the workspace.

createdAtstring date-time required
idstring uuid required

A UUID v4 string that identifies an entity.

isRemovedboolean required
referenceIdstring uuid nullable required

The ID of the original entity in production.

updatedAtstring date-time required
versionIdstring uuid required

A UUID v4 string that identifies an entity.

agentIdstring uuid required

The agent ID associated with the task.

conditionstring required

The condition that must be met for the task to be executed.

namestring required

The display name of the task.

promptstring required

What will be set as the main object of the agent when the task is selected.

status'active' | 'inactive' required

The lifecycle status of the task.