List Groups

groups.list() -> SyncArrayPage[Group]

get/v1/groups/

Fetch all multi-agent groups matching query.

ParametersExpand Collapse

after: Optional[str]

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

before: Optional[str]

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

limit: Optional[int]

Maximum number of groups to return

manager_type: Optional[ManagerType]

Search groups by manager type

Accepts one of the following:

"round_robin"

"supervisor"

"dynamic"

"sleeptime"

"voice_sleeptime"

"swarm"

order: Optional[Literal["asc", "desc"]]

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

Accepts one of the following:

"asc"

"desc"

order_by: Optional[Literal["created_at"]]

Field to sort by

Accepts one of the following:

"created_at"

project_id: Optional[str]

Search groups by project id

ReturnsExpand Collapse

class Group: …

id: str

The id of the group. Assigned by the database.

agent_ids: List[str]

description: str

manager_type: ManagerType

Accepts one of the following:

"round_robin"

"supervisor"

"dynamic"

"sleeptime"

"voice_sleeptime"

"swarm"

base_template_id: Optional[str]

The base template id.

deployment_id: Optional[str]

The id of the deployment.

hidden: Optional[bool]

If set to True, the group will be hidden.

last_processed_message_id: Optional[str]

manager_agent_id: Optional[str]

max_message_buffer_length: Optional[int]

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.

max_turns: Optional[int]

min_message_buffer_length: Optional[int]

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.

project_id: Optional[str]

The associated project id.

Deprecatedshared_block_ids: Optional[List[str]]

sleeptime_agent_frequency: Optional[int]

template_id: Optional[str]

The id of the template.

termination_token: Optional[str]

turns_counter: Optional[int]

List Groups

from letta_client import Letta

client = Letta(
    api_key="My API Key",
)
page = client.groups.list()
page = page.items[0]
print(page.id)

[
  {
    "id": "id",
    "agent_ids": [
      "string"
    ],
    "description": "description",
    "manager_type": "round_robin",
    "base_template_id": "base_template_id",
    "deployment_id": "deployment_id",
    "hidden": true,
    "last_processed_message_id": "last_processed_message_id",
    "manager_agent_id": "manager_agent_id",
    "max_message_buffer_length": 0,
    "max_turns": 0,
    "min_message_buffer_length": 0,
    "project_id": "project_id",
    "shared_block_ids": [
      "string"
    ],
    "sleeptime_agent_frequency": 0,
    "template_id": "template_id",
    "termination_token": "termination_token",
    "turns_counter": 0
  }
]

Returns Examples

[
  {
    "id": "id",
    "agent_ids": [
      "string"
    ],
    "description": "description",
    "manager_type": "round_robin",
    "base_template_id": "base_template_id",
    "deployment_id": "deployment_id",
    "hidden": true,
    "last_processed_message_id": "last_processed_message_id",
    "manager_agent_id": "manager_agent_id",
    "max_message_buffer_length": 0,
    "max_turns": 0,
    "min_message_buffer_length": 0,
    "project_id": "project_id",
    "shared_block_ids": [
      "string"
    ],
    "sleeptime_agent_frequency": 0,
    "template_id": "template_id",
    "termination_token": "termination_token",
    "turns_counter": 0
  }
]