TaskFlow
DashboardFreewriteWhiteboardsProjectsCRMTasksNotificationsSettingsAgent TowerAPI Docs
OpenClaw Docs
?

User

Member

Caricamento in corso...

Home
Progetti
Task
Notifiche
CRM

    OpenClaw

    Documentation Mirror

    Documentation Overview

    Docs

    Auth credential semantics
    Scheduled tasks
    Hooks
    Automation & tasks
    Standing orders
    Task flow
    Background tasks
    BlueBubbles
    Broadcast groups
    Channel routing
    Discord
    Feishu
    Google Chat
    Group messages
    Groups
    iMessage
    Chat channels
    IRC
    LINE
    Channel location parsing
    Matrix
    Matrix migration
    Matrix push rules for quiet previews
    Mattermost
    Microsoft Teams
    Nextcloud Talk
    Nostr
    Pairing
    QA channel
    QQ bot
    Signal
    Slack
    Synology Chat
    Telegram
    Tlon
    Channel troubleshooting
    Twitch
    WeChat
    WhatsApp
    Yuanbao
    Zalo
    Zalo personal
    CI pipeline
    ACP
    Agent
    Agents
    Approvals
    Backup
    Browser
    Channels
    Clawbot
    `openclaw commitments`
    Completion
    Config
    Configure
    Cron
    Daemon
    Dashboard
    Devices
    Directory
    DNS
    Docs
    Doctor
    Flows (redirect)
    Gateway
    Health
    Hooks
    CLI reference
    Inference CLI
    Logs
    MCP
    Memory
    Message
    Migrate
    Models
    Node
    Nodes
    Onboard
    Pairing
    Plugins
    Proxy
    QR
    Reset
    Sandbox CLI
    Secrets
    Security
    Sessions
    Setup
    Skills
    Status
    System
    `openclaw tasks`
    TUI
    Uninstall
    Update
    Voicecall
    Webhooks
    Wiki
    Active memory
    Agent runtime
    Agent loop
    Agent runtimes
    Agent workspace
    Gateway architecture
    Channel docking
    Inferred commitments
    Compaction
    Context
    Context engine
    Delegate architecture
    Dreaming
    Experimental features
    Features
    Markdown formatting
    Memory overview
    Builtin memory engine
    Honcho memory
    QMD memory engine
    Memory search
    Messages
    Model failover
    Model providers
    Models CLI
    Multi-agent routing
    OAuth
    OpenClaw App SDK
    Presence
    QA overview
    Matrix QA
    Command queue
    Steering queue
    Retry policy
    Session management
    Session pruning
    Session tools
    SOUL.md personality guide
    Streaming and chunking
    System prompt
    Timezones
    TypeBox
    Typing indicators
    Usage tracking
    Date and time
    Node + tsx crash
    Diagnostics flags
    Authentication
    Background exec and process tool
    Bonjour discovery
    Bridge protocol
    CLI backends
    Configuration — agents
    Configuration — channels
    Configuration — tools and custom providers
    Configuration
    Configuration examples
    Configuration reference
    Diagnostics export
    Discovery and transports
    Doctor
    Gateway lock
    Health checks
    Heartbeat
    Gateway runbook
    Local models
    Gateway logging
    Multiple gateways
    Network model
    OpenAI chat completions
    OpenResponses API
    OpenShell
    OpenTelemetry export
    Gateway-owned pairing
    Prometheus metrics
    Gateway protocol
    Remote access
    Remote gateway setup
    Sandbox vs tool policy vs elevated
    Sandboxing
    Secrets management
    Secrets apply plan contract
    Security audit checks
    Security
    Tailscale
    Tools invoke API
    Troubleshooting
    Trusted proxy auth
    Debugging
    Environment variables
    FAQ
    FAQ: first-run setup
    FAQ: models and auth
    GPT-5.5 / Codex agentic parity
    GPT-5.5 / Codex parity maintainer notes
    Help
    Scripts
    Testing
    Testing: live suites
    General troubleshooting
    OpenClaw
    Ansible
    Azure
    Bun (experimental)
    ClawDock
    Release channels
    DigitalOcean
    Docker
    Docker VM runtime
    exe.dev
    Fly.io
    GCP
    Hetzner
    Hostinger
    Install
    Installer internals
    Kubernetes
    macOS VMs
    Migration guide
    Migrating from Claude
    Migrating from Hermes
    Nix
    Node.js
    Northflank
    Oracle Cloud
    Podman
    Railway
    Raspberry Pi
    Render
    Uninstall
    Updating
    Logging
    Network
    Audio and voice notes
    Camera capture
    Image and media support
    Nodes
    Location command
    Media understanding
    Talk mode
    Node troubleshooting
    Voice wake
    Pi integration architecture
    Pi development workflow
    Android app
    Platforms
    iOS app
    Linux app
    Gateway on macOS
    Canvas
    Gateway lifecycle
    macOS dev setup
    Health checks (macOS)
    Menu bar icon
    macOS logging
    Menu bar
    Peekaboo bridge
    macOS permissions
    Remote control
    macOS signing
    Skills (macOS)
    Voice overlay
    Voice wake (macOS)
    WebChat (macOS)
    macOS IPC
    macOS app
    Windows
    Plugin internals
    Plugin architecture internals
    Building plugins
    Plugin bundles
    Codex Computer Use
    Codex harness
    Community plugins
    Plugin compatibility
    Google Meet plugin
    Plugin hooks
    Plugin manifest
    Memory LanceDB
    Memory wiki
    Message presentation
    Agent harness plugins
    Building channel plugins
    Channel turn kernel
    Plugin entry points
    Plugin SDK migration
    Plugin SDK overview
    Building provider plugins
    Plugin runtime helpers
    Plugin setup and config
    Plugin SDK subpaths
    Plugin testing
    Skill workshop plugin
    Voice call plugin
    Webhooks plugin
    Zalo personal plugin
    OpenProse
    Alibaba Model Studio
    Anthropic
    Arcee AI
    Azure Speech
    Amazon Bedrock
    Amazon Bedrock Mantle
    Chutes
    Claude Max API proxy
    Cloudflare AI gateway
    ComfyUI
    Deepgram
    Deepinfra
    DeepSeek
    ElevenLabs
    Fal
    Fireworks
    GitHub Copilot
    GLM (Zhipu)
    Google (Gemini)
    Gradium
    Groq
    Hugging Face (inference)
    Provider directory
    Inferrs
    Inworld
    Kilocode
    LiteLLM
    LM Studio
    MiniMax
    Mistral
    Model provider quickstart
    Moonshot AI
    NVIDIA
    Ollama
    OpenAI
    OpenCode
    OpenCode Go
    OpenRouter
    Perplexity
    Qianfan
    Qwen
    Runway
    SGLang
    StepFun
    Synthetic
    Tencent Cloud (TokenHub)
    Together AI
    Venice AI
    Vercel AI gateway
    vLLM
    Volcengine (Doubao)
    Vydra
    xAI
    Xiaomi MiMo
    Z.AI
    Default AGENTS.md
    Release policy
    API usage and costs
    Credits
    Device model database
    Full release validation
    Memory configuration reference
    OpenClaw App SDK API design
    Prompt caching
    Rich output protocol
    RPC adapters
    SecretRef credential surface
    Session management deep dive
    AGENTS.md template
    BOOT.md template
    BOOTSTRAP.md template
    HEARTBEAT.md template
    IDENTITY template
    SOUL.md template
    TOOLS.md template
    USER template
    Tests
    Token use and costs
    Transcript hygiene
    Onboarding reference
    Contributing to the threat model
    Threat model (MITRE ATLAS)
    Formal verification (security models)
    Network proxy
    Agent bootstrapping
    Docs directory
    Getting started
    Docs hubs
    OpenClaw lore
    Onboarding (macOS app)
    Onboarding overview
    Personal assistant setup
    Setup
    Showcase
    Onboarding (CLI)
    CLI automation
    CLI setup reference
    ACP agents
    ACP agents — setup
    Agent send
    apply_patch tool
    Brave search
    Browser (OpenClaw-managed)
    Browser control API
    Browser troubleshooting
    Browser login
    WSL2 + Windows + remote Chrome CDP troubleshooting
    BTW side questions
    ClawHub
    Code execution
    Creating skills
    Diffs
    DuckDuckGo search
    Elevated mode
    Exa search
    Exec tool
    Exec approvals
    Exec approvals — advanced
    Firecrawl
    Gemini search
    Grok search
    Image generation
    Tools and plugins
    Kimi search
    LLM task
    Lobster
    Tool-loop detection
    Media overview
    MiniMax search
    Multi-agent sandbox and tools
    Music generation
    Ollama web search
    PDF tool
    Perplexity search
    Plugins
    Reactions
    SearXNG search
    Skills
    Skills config
    Slash commands
    Sub-agents
    Tavily
    Thinking levels
    Tokenjuice
    Trajectory bundles
    Text-to-speech
    Video generation
    Web search
    Web fetch
    Linux server
    Control UI
    Dashboard
    Web
    TUI
    WebChat

    OpenAPI Specs

    openapi
    TaskFlow
    docs/openclaw
    Original Docs

    Real-time Synchronized Documentation

    Last sync: 01/05/2026 07:00:29

    Note: This content is mirrored from docs.openclaw.ai and is subject to their terms and conditions.

    OpenClaw Docs

    v2.4.0 Production

    Last synced: Today, 22:00

    Technical reference for the OpenClaw framework. Real-time synchronization with the official documentation engine.

    Use this file to discover all available pages before exploring further.

    Memory LanceDB

    text
    memory-lancedb
    is a bundled memory plugin that stores long-term memory in LanceDB and uses embeddings for recall. It can automatically recall relevant memories before a model turn and capture important facts after a response.

    Use it when you want a local vector database for memory, need an OpenAI-compatible embedding endpoint, or want to keep a memory database outside the default built-in memory store.

    note

    `memory-lancedb` is an active memory plugin. Enable it by selecting the memory slot with `plugins.slots.memory = "memory-lancedb"`. Companion plugins such as `memory-wiki` can run beside it, but only one plugin owns the active memory slot.

    Quick start

    json5
    { plugins: { slots: { memory: "memory-lancedb", }, entries: { "memory-lancedb": { enabled: true, config: { embedding: { provider: "openai", model: "text-embedding-3-small", }, autoRecall: true, autoCapture: false, }, }, }, }, }

    Restart the Gateway after changing plugin config:

    bash
    openclaw gateway restart

    Then verify the plugin is loaded:

    bash
    openclaw plugins list

    Provider-backed embeddings

    text
    memory-lancedb
    can use the same memory embedding provider adapters as
    text
    memory-core
    . Set
    text
    embedding.provider
    and omit
    text
    embedding.apiKey
    to use the provider's configured auth profile, environment variable, or
    text
    models.providers.<provider>.apiKey
    .

    json5
    { plugins: { slots: { memory: "memory-lancedb", }, entries: { "memory-lancedb": { enabled: true, config: { embedding: { provider: "openai", model: "text-embedding-3-small", }, autoRecall: true, }, }, }, }, }

    This path works with provider auth profiles that expose embedding credentials. For example, GitHub Copilot can be used when the Copilot profile/plan supports embeddings:

    json5
    { plugins: { slots: { memory: "memory-lancedb", }, entries: { "memory-lancedb": { enabled: true, config: { embedding: { provider: "github-copilot", model: "text-embedding-3-small", }, }, }, }, }, }

    OpenAI Codex / ChatGPT OAuth (

    text
    openai-codex
    ) is not an OpenAI Platform embeddings credential. For OpenAI embeddings, use an OpenAI API key auth profile,
    text
    OPENAI_API_KEY
    , or
    text
    models.providers.openai.apiKey
    . OAuth-only users can use another embedding-capable provider such as GitHub Copilot or Ollama.

    Ollama embeddings

    For Ollama embeddings, prefer the bundled Ollama embedding provider. It uses the native Ollama

    text
    /api/embed
    endpoint and follows the same auth/base URL rules as the Ollama provider documented in Ollama.

    json5
    { plugins: { slots: { memory: "memory-lancedb", }, entries: { "memory-lancedb": { enabled: true, config: { embedding: { provider: "ollama", baseUrl: "http://127.0.0.1:11434", model: "mxbai-embed-large", dimensions: 1024, }, recallMaxChars: 400, autoRecall: true, autoCapture: false, }, }, }, }, }

    Set

    text
    dimensions
    for non-standard embedding models. OpenClaw knows the dimensions for
    text
    text-embedding-3-small
    and
    text
    text-embedding-3-large
    ; custom models need the value in config so LanceDB can create the vector column.

    For small local embedding models, lower

    text
    recallMaxChars
    if you see context length errors from the local server.

    OpenAI-compatible providers

    Some OpenAI-compatible embedding providers reject the

    text
    encoding_format
    parameter, while others ignore it and always return
    text
    number[]
    vectors.
    text
    memory-lancedb
    therefore omits
    text
    encoding_format
    on embedding requests and accepts either float-array responses or base64-encoded float32 responses.

    If you have a raw OpenAI-compatible embeddings endpoint that does not have a bundled provider adapter, omit

    text
    embedding.provider
    (or leave it as
    text
    openai
    ) and set
    text
    embedding.apiKey
    plus
    text
    embedding.baseUrl
    . This preserves the direct OpenAI-compatible client path.

    Set

    text
    embedding.dimensions
    for providers whose model dimensions are not built in. For example, ZhiPu
    text
    embedding-3
    uses
    text
    2048
    dimensions:

    json5
    { plugins: { entries: { "memory-lancedb": { enabled: true, config: { embedding: { apiKey: "${ZHIPU_API_KEY}", baseUrl: "https://open.bigmodel.cn/api/paas/v4", model: "embedding-3", dimensions: 2048, }, }, }, }, }, }

    Recall and capture limits

    text
    memory-lancedb
    has two separate text limits:

    SettingDefaultRangeApplies to
    text
    recallMaxChars
    text
    1000
    100-10000text sent to the embedding API for recall
    text
    captureMaxChars
    text
    500
    100-10000assistant message length eligible for capture

    text
    recallMaxChars
    controls auto-recall, the
    text
    memory_recall
    tool, the
    text
    memory_forget
    query path, and
    text
    openclaw ltm search
    . Auto-recall prefers the latest user message from the turn and falls back to the full prompt only when no user message is available. This keeps channel metadata and large prompt blocks out of the embedding request.

    text
    captureMaxChars
    controls whether a response is short enough to be considered for automatic capture. It does not cap recall query embeddings.

    Commands

    When

    text
    memory-lancedb
    is the active memory plugin, it registers the
    text
    ltm
    CLI namespace:

    bash
    openclaw ltm list openclaw ltm search "project preferences" openclaw ltm stats

    The plugin also extends

    text
    openclaw memory
    with a non-vector
    text
    query
    subcommand that runs against the LanceDB table directly:

    bash
    openclaw memory query --cols id,text,createdAt --limit 20 openclaw memory query --filter "category = 'preference'" --order-by createdAt:desc
    • text
      --cols <columns>
      : comma-separated column allowlist (defaults to
      text
      id
      ,
      text
      text
      ,
      text
      importance
      ,
      text
      category
      ,
      text
      createdAt
      ).
    • text
      --filter <condition>
      : SQL-style WHERE clause; capped at 200 characters and restricted to alphanumerics, comparison operators, quotes, parentheses, and a small set of safe punctuation.
    • text
      --limit <n>
      : positive integer; default
      text
      10
      .
    • text
      --order-by <column>:<asc|desc>
      : in-memory sort applied after the filter; the sort column is auto-included in the projection.

    Agents also get LanceDB memory tools from the active memory plugin:

    • text
      memory_recall
      for LanceDB-backed recall
    • text
      memory_store
      for saving important facts, preferences, decisions, and entities
    • text
      memory_forget
      for removing matching memories

    Storage

    By default, LanceDB data lives under

    text
    ~/.openclaw/memory/lancedb
    . Override the path with
    text
    dbPath
    :

    json5
    { plugins: { entries: { "memory-lancedb": { enabled: true, config: { dbPath: "~/.openclaw/memory/lancedb", embedding: { apiKey: "${OPENAI_API_KEY}", model: "text-embedding-3-small", }, }, }, }, }, }

    text
    storageOptions
    accepts string key/value pairs for LanceDB storage backends and supports
    text
    ${ENV_VAR}
    expansion:

    json5
    { plugins: { entries: { "memory-lancedb": { enabled: true, config: { dbPath: "s3://memory-bucket/openclaw", storageOptions: { access_key: "${AWS_ACCESS_KEY_ID}", secret_key: "${AWS_SECRET_ACCESS_KEY}", endpoint: "${AWS_ENDPOINT_URL}", }, embedding: { apiKey: "${OPENAI_API_KEY}", model: "text-embedding-3-small", }, }, }, }, }, }

    Runtime dependencies

    text
    memory-lancedb
    depends on the native
    text
    @lancedb/lancedb
    package. Packaged OpenClaw installs first try the bundled runtime dependency and can repair the plugin runtime dependency under OpenClaw state when the bundled import is not available.

    If an older install logs a missing

    text
    dist/package.json
    or missing
    text
    @lancedb/lancedb
    error during plugin load, upgrade OpenClaw and restart the Gateway.

    If the plugin logs that LanceDB is unavailable on

    text
    darwin-x64
    , use the default memory backend on that machine, move the Gateway to a supported platform, or disable
    text
    memory-lancedb
    .

    Troubleshooting

    Input length exceeds the context length

    This usually means the embedding model rejected the recall query:

    text
    memory-lancedb: recall failed: Error: 400 the input length exceeds the context length

    Set a lower

    text
    recallMaxChars
    , then restart the Gateway:

    json5
    { plugins: { entries: { "memory-lancedb": { config: { recallMaxChars: 400, }, }, }, }, }

    For Ollama, also verify the embedding server is reachable from the Gateway host:

    bash
    curl http://127.0.0.1:11434/v1/embeddings \ -H "Content-Type: application/json" \ -d '{"model":"mxbai-embed-large","input":"hello"}'

    Unsupported embedding model

    Without

    text
    dimensions
    , only the built-in OpenAI embedding dimensions are known. For local or custom embedding models, set
    text
    embedding.dimensions
    to the vector size reported by that model.

    Plugin loads but no memories appear

    Check that

    text
    plugins.slots.memory
    points at
    text
    memory-lancedb
    , then run:

    bash
    openclaw ltm stats openclaw ltm search "recent preference"

    If

    text
    autoCapture
    is disabled, the plugin will recall existing memories but will not automatically store new ones. Use the
    text
    memory_store
    tool or enable
    text
    autoCapture
    if you want automatic capture.

    Related

    • Memory overview
    • Active memory
    • Memory search
    • Memory Wiki
    • Ollama

    © 2024 TaskFlow Mirror

    Powered by TaskFlow Sync Engine