39 KiB
Configuration Reference
Complete reference for LettaBot configuration options.
Config Sources
LettaBot checks these sources in priority order:
LETTABOT_CONFIG_YAMLenv var - Inline YAML or base64-encoded YAML (recommended for cloud/Docker)LETTABOT_CONFIGenv var - Explicit file path override./lettabot.yaml- Project-local (recommended for local dev)./lettabot.yml- Project-local alternate~/.lettabot/config.yaml- User global~/.lettabot/config.yml- User global alternate
Cloud / Docker Deployments
On platforms where you can't include a config file (Railway, Fly.io, Render, etc.), use LETTABOT_CONFIG_YAML to pass your entire config as a single environment variable:
# Encode your local config as base64
lettabot config encode
# Or manually
base64 < lettabot.yaml | tr -d '\n'
Set the output as LETTABOT_CONFIG_YAML on your platform. Raw YAML is also accepted (for platforms that support multi-line env vars).
Local Development
For local installs, either:
- Create
./lettabot.yamlin your project, or - Create
~/.lettabot/config.yamlfor global config, or - Set
export LETTABOT_CONFIG=/path/to/your/config.yaml
Interactive Editor
Run lettabot config tui for an interactive editor that covers server auth, agent identity, channels, and features. See CLI Tools for details.
Example Configuration
# Server connection
server:
mode: api # 'api' or 'docker' (legacy: 'cloud'/'selfhosted')
apiKey: letta_... # Required for api mode
api:
port: 8080 # Default: 8080 (or PORT env var)
# host: 0.0.0.0 # Uncomment for Docker/Railway
# corsOrigin: https://my.app # Uncomment for cross-origin access
# Agent settings (single agent mode)
# For multiple agents, use `agents:` array instead -- see Multi-Agent section
agent:
name: LettaBot
# id: agent-... # Optional: use existing agent
# Note: model is configured on the Letta agent server-side.
# Use `lettabot model set <handle>` to change it.
# Conversation routing (optional)
conversations:
mode: shared # "disabled" | "shared" | "per-channel" | "per-chat"
heartbeat: last-active # "dedicated" | "last-active" | "<channel>"
# Channel configurations
channels:
telegram:
enabled: true
token: "123456:ABC-DEF..."
dmPolicy: pairing
# streaming: true # Opt-in: progressively edit messages as tokens arrive
slack:
enabled: true
botToken: xoxb-...
appToken: xapp-...
dmPolicy: pairing
# streaming: true
discord:
enabled: true
token: "..."
dmPolicy: pairing
# streaming: true
whatsapp:
enabled: true
selfChat: true # IMPORTANT: true for personal numbers
dmPolicy: pairing
signal:
enabled: true
phone: "+1234567890"
selfChat: true
dmPolicy: pairing
# Features
features:
cron: true
heartbeat:
enabled: true
intervalMin: 60
# Polling (background checks for Gmail, etc.)
polling:
enabled: true
intervalMs: 60000 # Check every 60 seconds
gmail:
enabled: true
account: user@example.com
# Voice transcription
transcription:
provider: openai
apiKey: sk-... # Optional: falls back to OPENAI_API_KEY
model: whisper-1
# Attachment handling
attachments:
maxMB: 20
maxAgeDays: 14
Server Configuration
| Option | Type | Description |
|---|---|---|
server.mode |
'api' | 'docker' |
Connection mode (legacy aliases: 'cloud', 'selfhosted') |
server.apiKey |
string | API key for Letta API |
server.baseUrl |
string | URL for Docker/custom server (e.g., http://localhost:8283) |
server.logLevel |
'fatal' | 'error' | 'warn' | 'info' | 'debug' | 'trace' |
Log verbosity. Default: info. Env vars LOG_LEVEL / LETTABOT_LOG_LEVEL override. |
Logging
LettaBot uses structured logging via pino. In local dev, output is human-readable with colored timestamps and [Module] prefixes. In production (Railway/Docker), set LOG_FORMAT=json for structured JSON output that works with log aggregation tools.
Log levels -- set in config or via environment variable (env takes precedence):
server:
logLevel: info # fatal | error | warn | info | debug | trace
LOG_LEVEL=debug npm run dev # verbose output for debugging
LOG_FORMAT=json npm start # structured JSON for production
Debug logging -- to enable verbose per-channel debug output (replaces the old DEBUG_WHATSAPP=1 flag):
LOG_LEVEL=debug npm run dev
Output formats:
Local dev (default) -- single-line colored output:
[23:22:37] INFO: [Bot] Session subprocess ready
[23:22:37] WARN: [WhatsApp] Socket not available for access control
Production (LOG_FORMAT=json) -- structured JSON:
{"level":30,"time":1234567890,"module":"Bot","msg":"Session subprocess ready"}
Docker Server Mode
server:
mode: docker
baseUrl: http://localhost:8283
Run Letta server with Docker:
docker run -v ~/.letta/.persist/pgdata:/var/lib/postgresql/data \
-p 8283:8283 \
-e OPENAI_API_KEY="..." \
letta/letta:latest
Agent Configuration (Single Agent)
The default config uses agent: and channels: at the top level for a single agent:
| Option | Type | Description |
|---|---|---|
agent.id |
string | Use existing agent (skips creation) |
agent.name |
string | Name for new agent |
agent.displayName |
string | Prefix outbound messages (e.g. "💜 Signo") |
Note: The model is configured on the Letta agent server-side, not in the config file. Use
lettabot model showto see the current model andlettabot model set <handle>to change it. During initial setup (lettabot onboard), you'll be prompted to select a model for new agents.
For multiple agents, see Multi-Agent Configuration below.
Multi-Agent Configuration
Run multiple independent agents from a single LettaBot instance. Each agent gets its own channels, state, cron, heartbeat, and polling services.
Use the agents: array instead of the top-level agent: and channels: keys:
server:
mode: api
apiKey: letta_...
agents:
- name: work-assistant
# displayName: "🔧 Work" # Optional: prefix outbound messages
model: claude-sonnet-4
# id: agent-abc123 # Optional: use existing agent
conversations:
mode: shared
heartbeat: last-active
channels:
telegram:
token: ${WORK_TELEGRAM_TOKEN}
dmPolicy: pairing
slack:
botToken: ${SLACK_BOT_TOKEN}
appToken: ${SLACK_APP_TOKEN}
features:
cron: true
heartbeat:
enabled: true
intervalMin: 30
- name: personal-assistant
model: claude-sonnet-4
conversations:
mode: per-channel
heartbeat: dedicated
channels:
signal:
phone: "+1234567890"
selfChat: true
whatsapp:
enabled: true
selfChat: true
features:
heartbeat:
enabled: true
intervalMin: 60
Per-Agent Options
Each entry in agents: accepts:
| Option | Type | Required | Description |
|---|---|---|---|
name |
string | Yes | Agent name (used for display, creation, and state isolation) |
id |
string | No | Use existing agent ID (skips creation) |
displayName |
string | No | Prefix outbound messages (e.g. "💜 Signo") |
model |
string | No | Model for agent creation |
workingDir |
string | No | Working directory for this agent's SDK sessions (overrides global LETTABOT_WORKING_DIR) |
conversations |
object | No | Conversation routing (mode, heartbeat, perChannel overrides) |
channels |
object | No | Channel configs (same schema as top-level channels:). At least one agent must have channels. |
features |
object | No | Per-agent features (cron, heartbeat, memfs, maxToolCalls, allowedTools, etc.) |
polling |
object | No | Per-agent polling config (Gmail, etc.) |
integrations |
object | No | Per-agent integrations (Google, etc.) |
Conversation Routing
Conversation routing controls which incoming messages share a Letta conversation. Agent memory (blocks) is always shared -- only the message history is isolated.
conversations:
mode: shared # "disabled" | "shared" | "per-channel" | "per-chat"
heartbeat: last-active # "dedicated" | "last-active" | "<channel>"
maxSessions: 10 # per-chat only: max concurrent sessions (LRU eviction)
perChannel:
- bluesky # always separate, even in shared mode
Modes:
| Mode | Key | Description |
|---|---|---|
disabled |
"default" |
Always uses the agent's built-in default conversation. No new conversations are created. |
shared (default) |
"shared" |
One conversation across all channels and all chats |
per-channel |
"telegram", "discord", etc. |
One conversation per channel adapter. All Telegram groups share one conversation, all Discord channels share another. |
per-chat |
"telegram:12345" |
One conversation per unique chat within each channel. Every DM and group gets its own isolated message history. |
per-chat mode details:
Each active chat runs its own CLI subprocess. To prevent unbounded growth, sessions are LRU-evicted when the pool hits maxSessions (default: 10). When an evicted chat sends another message, the session is cheaply recreated from the stored conversation ID -- no message history is lost.
conversations:
mode: per-chat
maxSessions: 20 # optional, default 10
The /reset command in per-chat mode only clears the conversation for the chat it was issued from, not the entire channel.
perChannel overrides:
In shared mode, you can carve out specific channels to run independently while keeping the rest shared:
conversations:
mode: shared
perChannel:
- bluesky # Bluesky gets its own conversation; everything else shares one
heartbeat: Controls which conversation background triggers (heartbeats) use:
last-active-- use the most recently active conversationdedicated-- use a separate"heartbeat"conversation key<channel>-- use a specific channel name (e.g.,telegram)
| Option | Type | Default | Description |
|---|---|---|---|
conversations.mode |
'shared' | 'per-channel' | 'per-chat' |
'shared' |
Conversation isolation level |
conversations.heartbeat |
'last-active' | 'dedicated' | string |
'last-active' |
Which conversation heartbeats target |
conversations.maxSessions |
number | 10 |
Max concurrent sessions in per-chat mode (LRU eviction) |
conversations.perChannel |
string[] | [] |
Channels to isolate even in shared mode |
How it works
- Each agent is a separate Letta agent with its own conversation history and memory
- Agents have isolated state, channels, and services (see known limitations for exceptions)
- The
LettaGatewayorchestrates startup, shutdown, and message delivery across agents - Legacy single-agent configs (
agent:+channels:) continue to work unchanged
Migrating from single to multi-agent
Your existing config:
agent:
name: MyBot
channels:
telegram:
token: "..."
features:
cron: true
Becomes:
agents:
- name: MyBot
channels:
telegram:
token: "..."
features:
cron: true
The server: (including server.api:), transcription:, and attachments: sections remain at the top level (shared across all agents).
Known limitations
- Two agents cannot share the same channel type without ambiguous API routing (#219)
- WhatsApp/Signal session paths are not yet agent-scoped (#220)
Channel Configuration
All channels share these common options:
| Option | Type | Description |
|---|---|---|
enabled |
boolean | Enable this channel |
dmPolicy |
'pairing' | 'allowlist' | 'open' |
Access control mode |
allowedUsers |
string[] | User IDs/numbers for allowlist mode |
groupDebounceSec |
number | Debounce for group messages in seconds (default: 5, 0 = immediate) |
instantGroups |
string[] | Group/channel IDs that bypass debounce entirely (legacy) |
groups |
object | Per-group configuration map (use * as default) |
mentionPatterns |
string[] | Extra regex patterns for mention detection (Telegram/WhatsApp/Signal) |
streaming |
boolean | Stream responses via progressive message edits (default: false; Telegram/Discord/Slack only) |
Group Message Debouncing
In group chats, the bot debounces incoming messages to batch rapid-fire messages into a single response. The timer resets on each new message, so the bot waits for a quiet period before responding.
channels:
discord:
groupDebounceSec: 10 # Wait 10s of quiet before responding
instantGroups: # These groups get instant responses
- "123456789"
- Default: 5 seconds -- waits for 5s of quiet, then processes all buffered messages at once
groupDebounceSec: 0-- disables batching (every message processed immediately, like DMs)@mention-- always triggers an immediate response regardless of debounceinstantGroups-- listed groups bypass debounce entirely
The deprecated groupPollIntervalMin (minutes) still works for backward compatibility but groupDebounceSec takes priority.
Conversation Routing
See Conversation Routing under Multi-Agent Configuration for the full reference, including shared, per-channel, and per-chat modes.
In single-agent configs, conversations: goes at the top level. In multi-agent configs, it goes inside each agent entry.
Group Modes
Use groups.<id>.mode to control how each group/channel behaves:
open: process and respond to all messages (default behavior)listen: process all messages for context/memory, only respond when mentionedmention-only: drop group messages unless the bot is mentioneddisabled: drop all group messages unconditionally, even if the bot is mentioned
You can also use * as a wildcard default:
channels:
telegram:
groups:
"*": { mode: listen }
"-1001234567890": { mode: open }
"-1009876543210": { mode: mention-only }
Per-Group User Filtering
Use groups.<id>.allowedUsers to restrict which users can trigger the bot in a specific group. When set, messages from users not in the list are silently dropped before reaching the agent (no token cost).
channels:
discord:
groups:
"*":
mode: mention-only
allowedUsers:
- "123456789012345678" # Only this user triggers the bot
"TESTING_CHANNEL":
mode: open
# No allowedUsers -- anyone can interact in this channel
Resolution follows the same priority as mode: specific channel/group ID > guild/server ID > * wildcard. Omitting allowedUsers means all users are allowed.
This works across all channels (Discord, Telegram, Slack, Signal, WhatsApp).
Discord Thread Controls
Discord supports extra per-group controls for thread-first workflows:
groups.<id>.threadMode: thread-only-- bot responds only to messages in threadsgroups.<id>.autoCreateThreadOnMention: true-- for top-level @mentions, create a thread and reply there
Example (#ezra style):
channels:
discord:
groups:
"EZRA_CHANNEL_ID":
mode: open
threadMode: thread-only
autoCreateThreadOnMention: true
Thread messages inherit parent channel config, so child threads under EZRA_CHANNEL_ID use the same group rules.
When threadMode: thread-only is set, each thread automatically gets its own isolated conversation (message history). This overrides shared and per-channel conversation modes so that messages from different threads are never interleaved. Agent memory (blocks) is still shared across all threads. (In disabled mode, all messages use the agent's built-in default conversation and thread isolation does not apply.)
Finding Group IDs
Each channel uses different identifiers for groups:
- Telegram: Group IDs are negative numbers (e.g.,
-1001234567890). To find one: add@userinfobotto the group, or forward a group message to@userinfobot. You can also check the bot logs -- group IDs are printed when the bot receives a message. - Discord: Channel and server IDs are numeric strings (e.g.,
123456789012345678). Enable Developer Mode in Discord settings (User Settings > Advanced > Developer Mode), then right-click any channel or server and select "Copy Channel ID" or "Copy Server ID". - Slack: Channel IDs start with
C(e.g.,C01ABC23DEF). Right-click a channel > "View channel details" > scroll to the bottom to find the Channel ID. - WhatsApp: Group JIDs look like
120363123456@g.us. These appear in the bot logs when the bot receives a group message. - Signal: Group IDs appear in the bot logs on first group message. Use the
group:prefix in config (e.g.,group:abc123).
Tip: If you don't know the ID yet, start the bot with "*": { mode: mention-only }, send a message in the group, and check the logs for the ID.
Deprecated formats are still supported and auto-normalized with warnings:
listeningGroups: ["id"]->groups: { "id": { mode: listen } }groups: { "id": { requireMention: true/false } }->mode: mention-only/open
DM Policies
Note: For WhatsApp/Signal with selfChat: true (personal number), dmPolicy is ignored - only you can message via "Message Yourself" / "Note to Self".
For dedicated bot numbers (selfChat: false), onboarding defaults to allowlist:
allowlist(default for dedicated numbers): Only specified phone numbers can messagepairing: New users get a code, approve withlettabot pairing approveopen: Anyone can message (not recommended)
Channel-Specific Options
Telegram
| Option | Type | Description |
|---|---|---|
token |
string | Bot token from @BotFather |
Slack
| Option | Type | Description |
|---|---|---|
botToken |
string | Bot User OAuth Token (xoxb-...) |
appToken |
string | App-Level Token (xapp-...) for Socket Mode |
Discord
| Option | Type | Description |
|---|---|---|
token |
string | Bot token from Discord Developer Portal |
| Option | Type | Description |
|---|---|---|
selfChat |
boolean | Critical: true = only "Message Yourself" works |
Signal
| Option | Type | Description |
|---|---|---|
phone |
string | Phone number with + prefix |
selfChat |
boolean | true = only "Note to Self" works |
Features Configuration
Heartbeat
features:
heartbeat:
enabled: true
intervalMin: 60 # Check every 60 minutes
skipRecentUserMin: 5 # Skip auto-heartbeats for N minutes after user message (0 disables)
Heartbeats are background tasks where the agent can review pending work.
If the user messaged recently, automatic heartbeats are skipped by default for 5 minutes (skipRecentUserMin).
Set this to 0 to disable skipping. Manual /heartbeat bypasses the skip check.
Custom Heartbeat Prompt
You can customize what the agent is told during heartbeats. The custom text replaces the default body while keeping the silent mode envelope (time, trigger metadata, and messaging instructions).
Inline in YAML:
features:
heartbeat:
enabled: true
intervalMin: 60
prompt: "Check your todo list and work on the highest priority item."
From a file (re-read each tick, so edits take effect without restart):
features:
heartbeat:
enabled: true
intervalMin: 60
promptFile: ./prompts/heartbeat.md
Via environment variable:
HEARTBEAT_PROMPT="Review recent conversations" npm start
# Optional: HEARTBEAT_SKIP_RECENT_USER_MIN=0 to disable recent-user skip
Precedence: prompt (inline YAML) > HEARTBEAT_PROMPT (env var) > promptFile (file) > built-in default.
| Field | Type | Default | Description |
|---|---|---|---|
features.heartbeat.skipRecentUserMin |
number | 5 |
Skip auto-heartbeats for N minutes after a user message. Set 0 to disable. |
features.heartbeat.prompt |
string | (none) | Custom heartbeat prompt text |
features.heartbeat.promptFile |
string | (none) | Path to prompt file (relative to working dir) |
Send-File Directory
The <send-file> response directive allows the agent to send files to channels. For security, file paths are restricted to a configurable directory:
features:
sendFileDir: ./data/outbound # Default: agent working directory
Only files inside this directory (and its subdirectories) can be sent. Paths that resolve outside it are blocked. This prevents prompt injection attacks from exfiltrating sensitive files.
| Field | Type | Default | Description |
|---|---|---|---|
features.sendFileDir |
string | (workingDir) | Directory that <send-file> paths must be inside |
Sleeptime (Background Reflection)
Sleeptime lets the agent reflect on recent interactions in the background, updating its memory without being prompted. It requires memory filesystem (memfs: true) to be enabled -- if memfs is off, sleeptime is silently ignored with a startup warning.
features:
memfs: true
sleeptime:
trigger: step-count # "off" | "step-count" | "compaction-event"
behavior: reminder # "reminder" | "auto-launch"
stepCount: 10 # Steps between reflections (step-count trigger only)
Triggers:
| Trigger | Description |
|---|---|
off |
Disable sleeptime (explicit opt-out) |
step-count |
Reflect every N steps (configured via stepCount) |
compaction-event |
Reflect when the context window is compacted |
Behaviors:
| Behavior | Description |
|---|---|
reminder |
Agent is reminded to reflect but can choose to skip |
auto-launch |
Reflection is launched automatically |
Via environment variables (only used when features.sleeptime is not set in YAML):
SLEEPTIME_TRIGGER=step-count
SLEEPTIME_BEHAVIOR=reminder
SLEEPTIME_STEP_COUNT=10
| Field | Type | Default | Description |
|---|---|---|---|
features.sleeptime.trigger |
'off' | 'step-count' | 'compaction-event' |
(none) | When to trigger background reflection |
features.sleeptime.behavior |
'reminder' | 'auto-launch' |
(none) | How reflection is initiated |
features.sleeptime.stepCount |
number | (none) | Steps between reflections (only used with step-count trigger) |
Cron Jobs
features:
cron: true
Enable scheduled tasks. See Cron Setup.
Memory Filesystem (memfs)
Memory filesystem (also known as Context Repositories) syncs your agent's memory blocks to local files in a git-backed directory. This enables:
- Persistent local memory: Memory blocks are synced to
~/.letta/agents/<agent-id>/memory/as Markdown files - Git versioning: Every change to memory is automatically versioned with informative commit messages
- Direct editing: Memory files can be edited with standard tools and synced back to the agent
- Multi-agent collaboration: Subagents can work in git worktrees and merge changes back
features:
memfs: true
When memfs is enabled, the SDK passes --memfs to the Letta Code CLI on each session. When set to false, --no-memfs is passed to explicitly disable it. When omitted (default), the agent's existing memfs setting is left unchanged.
You can also enable memfs via environment variable (only true and false are recognized):
LETTABOT_MEMFS=true npm start
| Field | Type | Default | Description |
|---|---|---|---|
features.memfs |
boolean | (undefined) | Enable/disable memory filesystem. true enables, false disables, omit to leave unchanged. |
Known Limitations
- Headless conflict resolution (letta-ai/letta-code#808): If memory filesystem sync conflicts exist, the CLI exits with code 1 in headless mode (which is how lettabot runs). There is currently no way to resolve conflicts programmatically. Workaround: Run the agent interactively first (
letta --agent <agent-id>) to resolve conflicts, then restart lettabot. - Windows paths (letta-ai/letta-code#914): Path separator issues on Windows have been fixed in Letta Code, but ensure you're on the latest version.
For more details, see the Letta Code memory documentation and the Context Repositories blog post.
Display Tool Calls and Reasoning
Show optional "what the agent is doing" messages directly in channel output.
features:
display:
showToolCalls: true
showReasoning: false
reasoningMaxChars: 1200
In multi-agent configs, set this per agent:
agents:
- name: work-assistant
features:
display:
showToolCalls: true
| Field | Type | Default | Description |
|---|---|---|---|
features.display.showToolCalls |
boolean | false |
Show tool invocation summaries in chat output |
features.display.showReasoning |
boolean | false |
Show model reasoning/thinking text in chat output |
features.display.reasoningMaxChars |
number | 0 |
Truncate reasoning to N chars (0 = no limit) |
Notes:
- Tool call display filters out empty/null input fields and shows the final args for the tool call.
- Reasoning display uses plain bold/italic markdown for better cross-channel compatibility (including Signal).
- Display messages are informational; they do not replace the assistant response. Normal retry/error handling still applies if no assistant reply is produced.
Tool Access Control
Control which tools the agent can use. Useful for restricting public-facing agents to read-only operations while giving personal agents full access.
# Global defaults (apply to all agents unless overridden)
features:
allowedTools: [Bash, Read, Edit, Write, Glob, Grep, Task, web_search, conversation_search]
disallowedTools: [EnterPlanMode, ExitPlanMode]
Per-agent override:
agents:
- name: personal-bot
# Inherits global allowedTools (includes Bash, Edit, Write)
- name: public-bot
features:
allowedTools: [Read, Glob, Grep, web_search, conversation_search] # Read-only
| Field | Type | Default | Description |
|---|---|---|---|
features.allowedTools |
string[] | [Bash, Read, Edit, Write, Glob, Grep, Task, web_search, conversation_search] |
Tools the agent is allowed to use |
features.disallowedTools |
string[] | [EnterPlanMode, ExitPlanMode] |
Tools explicitly blocked |
Precedence: Per-agent YAML > global YAML features > ALLOWED_TOOLS / DISALLOWED_TOOLS env var > hardcoded default.
The manage_todo tool is always included regardless of configuration.
Per-Agent Working Directory
Each agent can have its own working directory, which sets the cwd for SDK sessions, heartbeat, and polling services:
agents:
- name: personal-bot
workingDir: ~/lettabot
- name: central-bot
workingDir: ~/central
| Field | Type | Default | Description |
|---|---|---|---|
workingDir |
string | LETTABOT_WORKING_DIR env var or process cwd |
Working directory for this agent's sessions |
No-Reply (Opt-Out)
The agent can choose not to respond to a message by sending exactly:
<no-reply/>
When the bot receives this marker, it suppresses the response and nothing is sent to the channel. This is useful in group chats where the agent shouldn't reply to every message.
The agent is taught about this behavior in two places:
- System prompt: A "Choosing Not to Reply" section explains when to use it (messages not directed at the agent, simple acknowledgments, conversations between other users, etc.)
- Message envelope: Group messages include a hint reminding the agent of the
<no-reply/>option. DMs do not include this hint.
The bot also handles this gracefully during streaming -- it holds back partial output while the response could still become <no-reply/>, so users never see a partial match leak through.
Polling Configuration
Background polling for integrations like Gmail. Runs independently of agent cron jobs.
polling:
enabled: true # Master switch (default: auto-detected from sub-configs)
intervalMs: 60000 # Check every 60 seconds (default: 60000)
gmail:
enabled: true
accounts: # Gmail accounts to poll
- user@example.com
- other@example.com
| Option | Type | Default | Description |
|---|---|---|---|
polling.enabled |
boolean | auto | Master switch. Defaults to true if any sub-config is enabled |
polling.intervalMs |
number | 60000 |
Polling interval in milliseconds |
polling.gmail.enabled |
boolean | auto | Enable Gmail polling. Auto-detected from account or accounts |
polling.gmail.account |
string | - | Gmail account to poll for unread messages |
polling.gmail.accounts |
(string | object)[] | - | Gmail accounts to poll. Can be strings or objects with account, prompt, promptFile |
polling.gmail.prompt |
string | - | Default custom prompt for all accounts |
polling.gmail.promptFile |
string | - | Path to default prompt file for all accounts |
Custom Email Prompts
You can customize what the agent is told when new emails are detected. The custom text replaces the default body while keeping the silent mode envelope (account, time, trigger metadata, and messaging instructions).
Inline prompt for all accounts:
polling:
gmail:
enabled: true
prompt: "Summarize these emails and flag anything urgent."
accounts:
- user@example.com
Per-account prompts:
polling:
gmail:
enabled: true
prompt: "Review these emails and notify me of anything important."
accounts:
- "personal@gmail.com" # Uses global prompt above
- account: "work@company.com"
prompt: "Focus on emails from executives and flag urgent matters."
- account: "notifications@example.com"
promptFile: ./prompts/notifications.txt # Re-read each poll
Prompt file for live editing:
polling:
gmail:
enabled: true
promptFile: ./prompts/email-review.md # Re-read each poll for live editing
accounts:
- user@example.com
Priority order:
- Account-specific
prompt(inline in accounts array) - Account-specific
promptFile - Global
polling.gmail.prompt - Global
polling.gmail.promptFile - Built-in default prompt
Legacy config path
For backward compatibility, Gmail polling can also be configured under integrations.google:
integrations:
google:
enabled: true
accounts:
- account: user@example.com
services: [gmail, calendar]
pollIntervalSec: 60
The top-level polling section takes priority if both are present.
Environment variable fallback
| Env Variable | Polling Config Equivalent |
|---|---|
GMAIL_ACCOUNT |
polling.gmail.account (comma-separated list allowed) |
POLLING_INTERVAL_MS |
polling.intervalMs |
PORT |
server.api.port |
API_HOST |
server.api.host |
API_CORS_ORIGIN |
server.api.corsOrigin |
Transcription Configuration
Voice message transcription (OpenAI Whisper or Mistral Voxtral):
transcription:
provider: openai # "openai" (default) or "mistral"
apiKey: sk-... # Optional: falls back to OPENAI_API_KEY / MISTRAL_API_KEY env var
model: whisper-1 # Default (OpenAI) or voxtral-mini-latest (Mistral)
See voice.md for provider details, supported formats, and troubleshooting.
Text-to-Speech (TTS) Configuration
Voice memo generation via the <voice> directive (ElevenLabs or OpenAI):
tts:
provider: elevenlabs # "elevenlabs" (default) or "openai"
apiKey: sk_475a... # Provider API key
voiceId: onwK4e9ZLuTAKqWW03F9 # Voice selection
model: eleven_multilingual_v2 # Optional model override
See voice.md for provider options, channel support, and CLI tools.
Attachments Configuration
attachments:
maxMB: 20 # Max file size to download (default: 20)
maxAgeDays: 14 # Auto-delete after N days (default: 14)
Attachments are stored in /tmp/lettabot/attachments/.
API Server Configuration
The built-in API server provides health checks, CLI messaging, and a chat endpoint for programmatic agent access.
Configure it under server.api: in your lettabot.yaml:
server:
mode: docker
baseUrl: http://localhost:8283
api:
port: 9090 # Default: 8080
host: 0.0.0.0 # Default: 127.0.0.1 (localhost only)
corsOrigin: "*" # Default: same-origin only
| Option | Type | Default | Description |
|---|---|---|---|
server.api.port |
number | 8080 |
Port for the API/health server |
server.api.host |
string | 127.0.0.1 |
Bind address. Use 0.0.0.0 for Docker/Railway |
server.api.corsOrigin |
string | (none) | CORS origin header for cross-origin access |
Note: Top-level
api:is still accepted for backward compatibility but deprecated. Move it underserver:to avoid warnings.
Chat Endpoint
Send messages to a lettabot agent and get responses via HTTP. Useful for integrating with other services, server-side tools, webhooks, or custom frontends.
Synchronous (default):
curl -X POST http://localhost:8080/api/v1/chat \
-H "Content-Type: application/json" \
-H "X-Api-Key: YOUR_API_KEY" \
-d '{"message": "What is on my todo list?"}'
Response:
{
"success": true,
"response": "Here are your current tasks...",
"agentName": "LettaBot"
}
Streaming (SSE):
curl -N -X POST http://localhost:8080/api/v1/chat \
-H "Content-Type: application/json" \
-H "Accept: text/event-stream" \
-H "X-Api-Key: YOUR_API_KEY" \
-d '{"message": "What is on my todo list?"}'
Each SSE event is a JSON object with a type field:
| Event type | Description |
|---|---|
reasoning |
Model thinking/reasoning tokens |
assistant |
Response text (may arrive in multiple chunks) |
tool_call |
Agent is calling a tool (toolName, toolCallId) |
tool_result |
Tool execution result (content, isError) |
result |
End of stream (success, optional error) |
Example stream:
data: {"type":"reasoning","content":"Let me check..."}
data: {"type":"assistant","content":"Here are your "}
data: {"type":"assistant","content":"current tasks."}
data: {"type":"result","success":true}
Asynchronous (fire-and-forget):
curl -X POST http://localhost:8080/api/v1/chat/async \
-H "Content-Type: application/json" \
-H "X-Api-Key: YOUR_API_KEY" \
-d '{"message": "Check my todos and let me know if anything is urgent."}'
Response (202 Accepted):
{
"success": true,
"status": "queued",
"agentName": "LettaBot"
}
Use this when you want to enqueue work and return immediately. The API does not return the agent's final text for this route.
Request fields:
| Field | Type | Required | Description |
|---|---|---|---|
message |
string | Yes | The message to send to the agent |
agent |
string | No | Agent name (defaults to first configured agent) |
Authentication: All requests require the X-Api-Key header. The API key is auto-generated on first run and saved to lettabot-api.json, or set via LETTABOT_API_KEY env var.
Multi-agent: In multi-agent configs, use the agent field to target a specific agent by name. Omit it to use the first agent. A 404 is returned if the agent name doesn't match any configured agent.
OpenAI-Compatible Endpoint
The API server also exposes /v1/chat/completions and /v1/models -- a drop-in OpenAI-compatible API. Use it with the OpenAI Python/Node SDK, Open WebUI, or any compatible client. See the OpenAI-Compatible API docs for details.
Environment Variables
Environment variables serve as fallbacks and can fill in missing credentials. If a channel block exists in YAML but is missing its key credential (e.g., signal: enabled: true without phone), the corresponding env var (e.g., SIGNAL_PHONE_NUMBER) will be merged in. YAML values always take priority -- env vars never overwrite values already set in the config file.
Reference:
| Env Variable | Config Equivalent |
|---|---|
LETTABOT_CONFIG |
Path to config file (overrides search order) |
LETTA_API_KEY |
server.apiKey |
LETTA_BASE_URL |
server.baseUrl |
LETTA_AGENT_ID |
agent.id |
LETTA_AGENT_NAME |
agent.name |
AGENT_NAME |
agent.name (legacy alias) |
TELEGRAM_BOT_TOKEN |
channels.telegram.token |
TELEGRAM_DM_POLICY |
channels.telegram.dmPolicy |
SLACK_BOT_TOKEN |
channels.slack.botToken |
SLACK_APP_TOKEN |
channels.slack.appToken |
DISCORD_BOT_TOKEN |
channels.discord.token |
WHATSAPP_ENABLED |
channels.whatsapp.enabled |
WHATSAPP_SELF_CHAT_MODE |
channels.whatsapp.selfChat |
SIGNAL_PHONE_NUMBER |
channels.signal.phone |
OPENAI_API_KEY |
transcription.apiKey |
GMAIL_ACCOUNT |
polling.gmail.account (comma-separated list allowed) |
POLLING_INTERVAL_MS |
polling.intervalMs |
LOG_LEVEL |
server.logLevel (fatal/error/warn/info/debug/trace). Overrides config. |
LETTABOT_LOG_LEVEL |
Alias for LOG_LEVEL |
LOG_FORMAT |
Set to json for structured JSON output (recommended for Railway/Docker) |
ALLOWED_TOOLS |
features.allowedTools (comma-separated list) |
DISALLOWED_TOOLS |
features.disallowedTools (comma-separated list) |
LETTABOT_WORKING_DIR |
Agent working directory (overridden by per-agent workingDir) |
SLEEPTIME_TRIGGER |
features.sleeptime.trigger (off/step-count/compaction-event) |
SLEEPTIME_BEHAVIOR |
features.sleeptime.behavior (reminder/auto-launch) |
SLEEPTIME_STEP_COUNT |
features.sleeptime.stepCount |
TTS_PROVIDER |
TTS backend: elevenlabs (default) or openai |
ELEVENLABS_API_KEY |
API key for ElevenLabs TTS |
ELEVENLABS_VOICE_ID |
ElevenLabs voice ID (default: onwK4e9ZLuTAKqWW03F9) |
ELEVENLABS_MODEL_ID |
ElevenLabs model (default: eleven_multilingual_v2) |
OPENAI_TTS_VOICE |
OpenAI TTS voice (default: alloy) |
OPENAI_TTS_MODEL |
OpenAI TTS model (default: tts-1) |
See SKILL.md for complete environment variable reference.