Skip to main content
GET
List agents

Authorizations

Authorization
string
header
required

A Recursion API key, created in the console under API keys.

Headers

x-tenant-id
string

Optional tenant consistency check. When present, it must name the tenant bound to the API key, including when x-organization-id is default.

Minimum string length: 1
x-organization-id
string

Organization in which to act. Required for a tenant-scoped API key. Optional for an organization-scoped key, where it must name that same organization. The value may be an organization id or default.

Minimum string length: 1

Query Parameters

limit
integer
default:50

Maximum agents per page, default 50.

Required range: 1 <= x <= 100
cursor
string

Opaque nextCursor from the previous page with the same limit and filters.

tagIdsAll
string[]

Repeat once for each tag id. Every returned agent must carry all supplied tags.

Required array length: 1 - 32 elements
namePrefix
string

Only agents whose name starts with this text, compared case-insensitively.

Required string length: 1 - 200
agentId
string<uuid>[]

Repeat once for each agent id, as a lowercase canonical UUID (at most 100 distinct ids) to list only those agents. Ids that name no live agent in the organization are left out.

Required array length: 1 - 100 elements
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Response

OK

items
object[]
required

One page of agents in the caller's organization, newest first, with server-authored execution compatibility.

nextCursor
null | string
required

Opaque cursor for the next page, or null at the end.

total
integer<int64>
required

Number of live agents matching the supplied filters.

Required range: 0 <= x <= 9007199254740991