Send Message To Group

1 import { LettaClient } from "@letta-ai/letta-client"; 2 3 const client = new LettaClient({ token: "YOUR_TOKEN", project: "YOUR_PROJECT" }); 4 await client.groups.messages.create("group-123e4567-e89b-42d3-8456-426614174000", { 5 messages: [{ 6 role: "user", 7 content: [{ 8 type: "text", 9 text: "The sky above the port was the color of television, tuned to a dead channel." 10 }] 11 }] 12 });

1 { 2 "messages": [ 3 { 4 "id": "string", 5 "date": "2024-01-15T09:30:00Z", 6 "name": "string", 7 "message_type": "system_message", 8 "otid": "string", 9 "sender_id": "string", 10 "step_id": "string", 11 "is_err": true, 12 "seq_id": 1, 13 "run_id": "string", 14 "content": "string" 15 } 16 ], 17 "stop_reason": { 18 "stop_reason": "end_turn", 19 "message_type": "stop_reason" 20 }, 21 "usage": { 22 "message_type": "usage_statistics", 23 "completion_tokens": 0, 24 "prompt_tokens": 0, 25 "total_tokens": 0, 26 "step_count": 0, 27 "run_ids": [ 28 "string" 29 ] 30 } 31 }

Process a user message and return the group's response. This endpoint accepts a message from a user and processes it through through agents in the group based on the specified pattern

Authentication

AuthorizationBearer

Header authentication of the form Bearer <token>

Path parameters

group_idstringRequiredformat: "^group-[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"=42 characters

The ID of the group in the format ‘group-<uuid4>’

Request

This endpoint expects an object.

messageslist of objectsRequired

The messages to be sent to the agent.

max_stepsintegerOptionalDefaults to 50

Maximum number of steps the agent should take to process the request.

include_return_message_typeslist of enums or nullOptional

Only return specified message types in the response. If None (default) returns all messages.

use_assistant_messagebooleanOptionalDefaults to trueDeprecated

Whether the server should parse specific tool call arguments (default send_message) as AssistantMessage objects. Still supported for legacy agent types, but deprecated for letta_v1_agent onward.

assistant_message_tool_namestringOptionalDefaults to send_messageDeprecated

The name of the designated message tool. Still supported for legacy agent types, but deprecated for letta_v1_agent onward.

assistant_message_tool_kwargstringOptionalDefaults to messageDeprecated

The name of the message argument in the designated message tool. Still supported for legacy agent types, but deprecated for letta_v1_agent onward.

enable_thinkingstringOptionalDeprecated

If set to True, enables reasoning before responses or tool calls from the agent.

Response

Successful Response

messageslist of objects

The messages returned by the agent.

stop_reasonobject

The stop reason from Letta indicating why agent loop stopped execution.

usageobject

The usage statistics of the agent.

Authentication

Path parameters

Request

Response

Errors