Send Message to Environment

post/v1/environments/{connectionId}/messages

Send a message to a specific environment connection

Path ParametersExpand Collapse

connectionId: string

Body ParametersExpand Collapse

messages: array of object { client_message_id, content, role, otid } or object { approvals, type }

Accepts one of the following:

UnionMember0 = object { client_message_id, content, role, otid }

client_message_id: string

content: string or array of object { text, type }

Accepts one of the following:

UnionMember0 = string

UnionMember1 = array of object { text, type }

text: string

type: "text"

role: "user"

otid: optional string

UnionMember1 = object { approvals, type }

approvals: array of object { status, tool_call_id, tool_return, 3 more } or object { approve, tool_call_id, reason, 2 more }

Accepts one of the following:

UnionMember0 = object { status, tool_call_id, tool_return, 3 more }

status: "success" or "error"

Accepts one of the following:

"success"

"error"

tool_call_id: string

tool_return: string or array of object { text, type }

Accepts one of the following:

UnionMember0 = string

UnionMember1 = array of object { text, type }

text: string

type: "text"

stderr: optional array of string

stdout: optional array of string

type: optional "tool"

UnionMember1 = object { approve, tool_call_id, reason, 2 more }

approve: boolean

tool_call_id: string

reason: optional string

type: optional "approval"

updated_input: optional map[unknown]

type: "approval"

agentId: optional string

conversationId: optional string

ReturnsExpand Collapse

message: string

success: boolean

Send Message to Environment

curl https://api.letta.com/v1/environments/$CONNECTION_ID/messages \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $LETTA_API_KEY" \
    -d '{
          "messages": [
            {
              "client_message_id": "client_message_id",
              "content": "string",
              "role": "user"
            }
          ]
        }'

{
  "message": "message",
  "success": true
}

Returns Examples

{
  "message": "message",
  "success": true
}