Sign in

v36

latestOpenAPI 3.1.0raw.githubusercontent.com2025-10-091882241.2 MB
groups

List Groups

Fetch all multi-agent groups matching query.

get/v1/groups/

Query parameters

manager_type'round_robin' | 'supervisor' | 'dynamic' | 'sleeptime' | 'voice_sleeptime' | 'swarm'

Search groups by manager type

beforestring nullable

Group ID cursor for pagination. Returns groups that come before this group ID in the specified sort order

Group ID cursor for pagination. Returns groups that come before this group ID in the specified sort order

afterstring nullable

Group ID cursor for pagination. Returns groups that come after this group ID in the specified sort order

Group ID cursor for pagination. Returns groups that come after this group ID in the specified sort order

limitinteger nullable

Maximum number of groups to return

Maximum number of groups to return

order'asc' | 'desc'

Sort order for groups by creation time. 'asc' for oldest first, 'desc' for newest first

Sort order for groups by creation time. 'asc' for oldest first, 'desc' for newest first

order_by'created_at'

Field to sort by

Field to sort by

project_idstring nullable

Search groups by project id

Search groups by project id

Response

Successful Response

idstring required

The id of the group. Assigned by the database.

manager_type'round_robin' | 'supervisor' | 'dynamic' | 'sleeptime' | 'voice_sleeptime' | 'swarm' required
agent_idsstring[] required
descriptionstring required
project_idstring nullable

The associated project id.

template_idstring nullable

The id of the template.

base_template_idstring nullable

The base template id.

deployment_idstring nullable

The id of the deployment.

shared_block_idsstring[]
manager_agent_idstring nullable
termination_tokenstring nullable
max_turnsinteger nullable
sleeptime_agent_frequencyinteger nullable
turns_counterinteger nullable
last_processed_message_idstring nullable
max_message_buffer_lengthinteger nullable

The desired maximum length of messages in the context window of the convo agent. This is a best effort, and may be off slightly due to user/assistant interleaving.

min_message_buffer_lengthinteger nullable

The desired minimum length of messages in the context window of the convo agent. This is a best effort, and may be off-by-one due to user/assistant interleaving.

hiddenboolean nullable

If set to True, the group will be hidden.