/api/v1/tasks (GET)

GET

/api/v1/tasks

const url = 'https://api.endless.zaia.app/api/v1/tasks?pageNumber=1&pageSize=10';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://api.endless.zaia.app/api/v1/tasks?pageNumber=1&pageSize=10'

Retrieves multiple tasks.

Parameters

Query Parameters

agentIds

Any of:

Array<string>
string

Array<string>

pageNumber

The page number.

number

default: 1 >= 1

The page number.

pageSize

The page size.

number

default: 10 >= 1 <= 100

The page size.

versionIds

Any of:

Array<string>
string

Array<string>

Responses

200

Retrieves all tasks for the workspace.

application/json

Array<object>

object

createdAt

required

string format: date-time

required

A UUID v4 string that identifies an entity.

string format: uuid

isRemoved

required

boolean

referenceId

required

The ID of the original entity in production.

string format: uuid

nullable

updatedAt

required

string format: date-time

versionId

required

A UUID v4 string that identifies an entity.

string format: uuid

agentId

required

The agent ID associated with the task.

string format: uuid

condition

required

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

string

>= 3 characters <= 250 characters

name

required

The display name of the task.

string

>= 3 characters <= 50 characters

prompt

required

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

string

>= 3 characters <= 2000 characters

status

required

The lifecycle status of the task.

string

Allowed values: active inactive

Example

[
  {
    "status": "active"
  }
]

401

Unauthorized.

application/json

The description of a known exception.

object

code

The error code.

string

cta

The error call-to-action.

object

type

required

string

Allowed values: support-contact

url

required

string format: uri

feedback

required

The error feedback.

object

enUs

string

esEs

string

ptBr

string

message

required

The error message.

string

name

required

The error name.

string

Example

{
  "cta": {
    "type": "support-contact"
  }
}