Skip to content
Letta Letta Letta Docs
Discord
API Reference

Environments

List Environment Connections
client.environments.list(EnvironmentListParams { after, limit, onlineOnly, 2 more } query?, RequestOptionsoptions?): EnvironmentListResponse { connections, hasNextPage }
GET/v1/environments
Get Environment Connection
client.environments.retrieve(stringdeviceID, RequestOptionsoptions?): EnvironmentRetrieveResponse { id, connectedAt, connectionId, 11 more }
GET/v1/environments/{deviceId}
Send Message to Environment
client.environments.sendMessage(stringconnectionID, EnvironmentSendMessageParams { messages, agentId, conversationId } body, RequestOptionsoptions?): EnvironmentSendMessageResponse { message, success }
POST/v1/environments/{connectionId}/messages
ModelsExpand Collapse
EnvironmentListResponse { connections, hasNextPage }
connections: Array<Connection>
id: string
connectedAt: number | null
connectionId: string | null
connectionName: string
deviceId: string
firstSeenAt: number
lastHeartbeat: number | null
lastSeenAt: number
organizationId: string
podId: string | null
apiKeyOwner?: string
currentMode?: "default" | "standard" | "acceptEdits" | 2 more
One of the following:
"default"
"standard"
"acceptEdits"
"bypassPermissions"
"unrestricted"
metadata?: Metadata { gitBranch, lettaCodeVersion, nodeVersion, 4 more }
gitBranch?: string
lettaCodeVersion?: string
nodeVersion?: string
os?: string
self_update?: SelfUpdate { supported, writable, install_path, 2 more }
supported: boolean
writable: boolean
install_path?: string
manual_command?: string
reason?: string
supported_commands?: Array<string>
workingDirectory?: string
userId?: string
hasNextPage: boolean
EnvironmentRetrieveResponse { id, connectedAt, connectionId, 11 more }
id: string
connectedAt: number | null
connectionId: string | null
connectionName: string
deviceId: string
firstSeenAt: number
lastHeartbeat: number | null
lastSeenAt: number
organizationId: string
podId: string | null
apiKeyOwner?: string
currentMode?: "default" | "standard" | "acceptEdits" | 2 more
One of the following:
"default"
"standard"
"acceptEdits"
"bypassPermissions"
"unrestricted"
metadata?: Metadata { gitBranch, lettaCodeVersion, nodeVersion, 4 more }
gitBranch?: string
lettaCodeVersion?: string
nodeVersion?: string
os?: string
self_update?: SelfUpdate { supported, writable, install_path, 2 more }
supported: boolean
writable: boolean
install_path?: string
manual_command?: string
reason?: string
supported_commands?: Array<string>
workingDirectory?: string
userId?: string
EnvironmentSendMessageResponse { message, success }
message: string
success: boolean