Retrieve Group

client.groups.retrieve(, ?): Group { id, agent_ids, description, 15 more }

get/v1/groups/{group_id}

Retrieve the group by id.

ParametersExpand Collapse

groupID: string

The ID of the group in the format 'group-'

minLength42

maxLength42

ReturnsExpand Collapse

Group { id, agent_ids, description, 15 more }

id: string

The id of the group. Assigned by the database.

agent_ids: Array<string>

description: string

manager_type: ManagerType

Accepts one of the following:

"round_robin"

"supervisor"

"dynamic"

"sleeptime"

"voice_sleeptime"

"swarm"

base_template_id?: string | null

The base template id.

deployment_id?: string | null

The id of the deployment.

hidden?: boolean | null

If set to True, the group will be hidden.

last_processed_message_id?: string | null

manager_agent_id?: string | null

max_message_buffer_length?: number | null

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?: number | null

min_message_buffer_length?: number | null

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?: string | null

The associated project id.

Deprecatedshared_block_ids?: Array<string>

sleeptime_agent_frequency?: number | null

template_id?: string | null

The id of the template.

termination_token?: string | null

turns_counter?: number | null

Retrieve Group

import Letta from '@letta-ai/letta-client';

const client = new Letta({
  apiKey: 'My API Key',
});

const group = await client.groups.retrieve('group-123e4567-e89b-42d3-8456-426614174000');

console.log(group.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
}