API Reference

View as Markdown

View as Markdown

Copy Markdown

---

Open in Claude

Open in ChatGPT

Groups

List Groups

client.groups.list(GroupListParams { after, before, limit, 4 more } query?, RequestOptionsoptions?): ArrayPage<Group { id, agent_ids, description, 15 more } >

get/v1/groups/

Create Group

client.groups.create(GroupCreateParams { agent_ids, description, hidden, 3 more } body, RequestOptionsoptions?): Group { id, agent_ids, description, 15 more }

post/v1/groups/

Retrieve Group

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

get/v1/groups/{group_id}

Modify Group

client.groups.modify(stringgroupID, GroupModifyParams { agent_ids, description, manager_config, 2 more } body, RequestOptionsoptions?): Group { id, agent_ids, description, 15 more }

patch/v1/groups/{group_id}

Delete Group

client.groups.delete(stringgroupID, RequestOptionsoptions?): GroupDeleteResponse

delete/v1/groups/{group_id}

ModelsExpand Collapse

DynamicManager { manager_agent_id, manager_type, max_turns, termination_token }

manager_agent_id: string

manager_type?: "dynamic"

Accepts one of the following:

"dynamic"

max_turns?: number | null

termination_token?: string | null

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

ManagerType = "round_robin" | "supervisor" | "dynamic" | 3 more

Accepts one of the following:

"round_robin"

"supervisor"

"dynamic"

"sleeptime"

"voice_sleeptime"

"swarm"

RoundRobinManager { manager_type, max_turns }

manager_type?: "round_robin"

Accepts one of the following:

"round_robin"

max_turns?: number | null

SleeptimeManager { manager_agent_id, manager_type, sleeptime_agent_frequency }

manager_agent_id: string

manager_type?: "sleeptime"

Accepts one of the following:

"sleeptime"

sleeptime_agent_frequency?: number | null

SupervisorManager { manager_agent_id, manager_type }

manager_agent_id: string

manager_type?: "supervisor"

Accepts one of the following:

"supervisor"

VoiceSleeptimeManager { manager_agent_id, manager_type, max_message_buffer_length, min_message_buffer_length }

manager_agent_id: string

manager_type?: "voice_sleeptime"

Accepts one of the following:

"voice_sleeptime"

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.

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.

GroupsMessages

Send Group Message

client.groups.messages.send(stringgroupID, MessageSendParams { assistant_message_tool_kwarg, assistant_message_tool_name, enable_thinking, 5 more } body, RequestOptionsoptions?): LettaResponse { messages, stop_reason, usage }

post/v1/groups/{group_id}/messages

List Group Messages

client.groups.messages.list(stringgroupID, MessageListParams { after, assistant_message_tool_kwarg, assistant_message_tool_name, 5 more } query?, RequestOptionsoptions?): ArrayPage<LettaMessageUnion>

get/v1/groups/{group_id}/messages

Send Group Message Streaming

client.groups.messages.stream(stringgroupID, MessageStreamParams { assistant_message_tool_kwarg, assistant_message_tool_name, background, 9 more } body, RequestOptionsoptions?): MessageStreamResponse | Stream<LettaStreamingResponse>

post/v1/groups/{group_id}/messages/stream

Modify Group Message

client.groups.messages.modify(stringmessageID, MessageModifyParamsparams, RequestOptionsoptions?): MessageModifyResponse

patch/v1/groups/{group_id}/messages/{message_id}

Reset Group Messages

client.groups.messages.reset(stringgroupID, RequestOptionsoptions?): MessageResetResponse

patch/v1/groups/{group_id}/reset-messages