/api/v1/agents (GET)

GET

/api/v1/agents

const url = 'https://api.endless.zaia.app/api/v1/agents?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/agents?pageNumber=1&pageSize=10'

Retrieves multiple agents.

Parameters

Query Parameters

joins

Any of:

Array<string>
string

Array<string>

Allowed values: squads

pageNumber

The page number.

number

default: 1 >= 1

The page number.

pageSize

The page size.

number

default: 10 >= 1 <= 100

The page size.

referenceIds

Any of:

Array<string>
string

Array<string>

search

Search term to filter agents by name, internal name, role, or prompt.

string

>= 1 characters

Search term to filter agents by name, internal name, role, or prompt.

squadIds

Any of:

Array<string>
string

Array<string>

versionIds

Any of:

Array<string>
string

Array<string>

Responses

200

Retrieves all agents for the workspace.

application/json

Array

Any of:

object
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

codeRuntime

required

Whether the agent should be able to execute JavaScript code using the Code Runtime tool.

boolean

internalName

required

The internal name of the agent. For internal use only.

string

nullable >= 3 characters <= 50 characters

iterations

required

The number of iterations (steps) the agent can execute in a single execution.

number

>= 2 <= 100

llm

required

The LLM model key to use for the agent.

string

Allowed values: claude-haiku-4-5 claude-opus-4-8 claude-opus-4-6 claude-opus-4-5 claude-sonnet-4-6 claude-sonnet-4-5 gpt-5.2 gpt-5.5 gpt-5.4 gpt-5.4-mini gpt-5.4-nano gpt-5.6-luna gpt-5.6-sol gpt-5.6-terra gemini-2.5-flash gemini-2.5-pro gemini-3.5-flash gemini-3-flash gemini-3-pro gemini-3.1-pro kimi-k2.5 kimi-k2.6 grok-4.3 grok-4.5

llmProviderId

required

The id of the LLM provider to use for the agent.

string format: uuid

nullable

name

required

The name of the agent.

string

>= 3 characters <= 50 characters

picture

required

The picture of the agent.

string

nullable

planning

required

Whether the agent should plan before each execution.

boolean

prompt

required

The main description of the agent’s behavior.

string

>= 1 characters <= 10000 characters

reasoningMode

required

The reasoning mode to use for the agent. If null, reasoning will be disabled.

string

nullable

Allowed values: low medium high xhigh

role

required

The role of the agent. Particularly useful to give other agents context of what the agent does.

string

>= 1 characters <= 250 characters

superIdentityId

required

The super identity ID associated with the agent.

string format: uuid

temperature

required

The temperature to use for the agent. The lower the more deterministic. The higher the more creative.

number

<= 2

timezone

required

The timezone to use for the agent. If null, no timezone will be used.

string

nullable

Allowed values: Africa/Cairo Africa/Johannesburg America/Chicago America/Denver America/Los_Angeles America/New_York America/Sao_Paulo America/Manaus Asia/Dubai Asia/Kolkata Asia/Shanghai Asia/Singapore Asia/Tokyo Australia/Sydney Europe/Berlin Europe/London Europe/Moscow Europe/Paris Pacific/Auckland Pacific/Auckland2 UTC auto

toolCount

required

The number of tools currently associated with the agent.

integer

voiceId

required

The TTS voice to use for audio responses. Null when disabled for the agent.

string format: uuid

nullable

workspaceId

required

The workspace ID that owns the agent.

string format: uuid

squadAgents

required

Array<object>

object

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

agentId

required

A UUID v4 string that identifies an entity.

string format: uuid

squadId

required

A UUID v4 string that identifies an entity.

string format: uuid

type

required

string

Allowed values: member main

squad

required

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

description

required

The internal description of the squad.

string

nullable >= 3 characters <= 250 characters

mode

required

The management mode. In flat, agents redirect the chat to one another. In hierarchical, all iterations are intermediated by the manager.

string

Allowed values: hierarchical flat

name

required

The display name of the squad.

string

>= 3 characters <= 50 characters

picture

required

The picture associated with the squad.

string

nullable

superIdentityId

required

The super identity ID associated with the squad.

string format: uuid

workspaceId

required

The workspace ID that owns the squad.

string format: uuid

Example

[
  {
    "llm": "claude-haiku-4-5",
    "reasoningMode": "low",
    "timezone": "Africa/Cairo",
    "squadAgents": [
      {
        "type": "member",
        "squad": {
          "mode": "hierarchical"
        }
      }
    ]
  }
]

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"
  }
}