Agents

List agents

Retrieve a paginated list of all agents. Filter by agent type with type (e.g. type=LOCAL) and by owner user ID with owner.

GET /agents/

Authorization

HeaderTypeDescription

Authorizationrequired

string

Header with your API key as a Bearer token: Bearer <api-key>. See Authentication.

Query parameters

NameTypeDescription

page

integer

Page number

Default: 1

limit

integer

Items per page

Default: 10

sortBy

string

First-level field to sort by

sortOrder

string

Sort order: asc or desc

Default: "desc"

archived

boolean

When true, list only archived items; default lists only non-archived items. No-op for models without an isArchived field.

Default: false

output

enum<string>

Response shape: 'full' (default) returns complete documents; 'minimal' returns lean rows for list views, omitting heavy embedded fields while keeping linked display fields resolved.

Allowed values: full, minimalDefault: "full"

Response

200Successful Response

PropertyTypeDescription

datarequired

object[]

idrequired

string

createdAt

string (date-time)

updatedAt

string (date-time)

namerequired

string

typerequired

string

config

object

The agent's settings, by type. A KINDLY agent's callbackToken makes its reply URL. Secrets are kept apart and never returned.

Default: {}

metadata

object

Metadata set when the agent was registered

Default: {}

owner

object

The member a personal agent belongs to

id

string

name

string

isEnabled

boolean

Default: true

isArchived

boolean

Default: false

totalrequired

integer

pagerequired

integer

limitrequired

integer

Agents

Create agent