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:04:06

    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.

    Messages

    OpenClaw handles inbound messages through a pipeline of session resolution, queueing, streaming, tool execution, and reasoning visibility. This page maps the path from inbound message to reply.

    Message flow (high level)

    text
    Inbound message -> routing/bindings -> session key -> queue (if a run is active) -> agent run (streaming + tools) -> outbound replies (channel limits + chunking)

    Key knobs live in configuration:

    • text
      messages.*
      for prefixes, queueing, and group behavior.
    • text
      agents.defaults.*
      for block streaming and chunking defaults.
    • Channel overrides (
      text
      channels.whatsapp.*
      ,
      text
      channels.telegram.*
      , etc.) for caps and streaming toggles.

    See Configuration for full schema.

    Inbound dedupe

    Channels can redeliver the same message after reconnects. OpenClaw keeps a short-lived cache keyed by channel/account/peer/session/message id so duplicate deliveries do not trigger another agent run.

    Inbound debouncing

    Rapid consecutive messages from the same sender can be batched into a single agent turn via

    text
    messages.inbound
    . Debouncing is scoped per channel + conversation and uses the most recent message for reply threading/IDs.

    Config (global default + per-channel overrides):

    json5
    { messages: { inbound: { debounceMs: 2000, byChannel: { whatsapp: 5000, slack: 1500, discord: 1500, }, }, }, }

    Notes:

    • Debounce applies to text-only messages; media/attachments flush immediately.
    • Control commands bypass debouncing so they remain standalone — except when a channel explicitly opts in to same-sender DM coalescing (e.g. BlueBubbles
      text
      coalesceSameSenderDms
      ), where DM commands wait inside the debounce window so a split-send payload can join the same agent turn.

    Sessions and devices

    Sessions are owned by the gateway, not by clients.

    • Direct chats collapse into the agent main session key.
    • Groups/channels get their own session keys.
    • The session store and transcripts live on the gateway host.

    Multiple devices/channels can map to the same session, but history is not fully synced back to every client. Recommendation: use one primary device for long conversations to avoid divergent context. The Control UI and TUI always show the gateway-backed session transcript, so they are the source of truth.

    Details: Session management.

    Tool result metadata

    Tool result

    text
    content
    is the model-visible result. Tool result
    text
    details
    is runtime metadata for UI rendering, diagnostics, media delivery, and plugins.

    OpenClaw keeps that boundary explicit:

    • text
      toolResult.details
      is stripped before provider replay and compaction input.
    • Persisted session transcripts keep only bounded
      text
      details
      ; oversized metadata is replaced with a compact summary marked
      text
      persistedDetailsTruncated: true
      .
    • Plugins and tools should put text the model must read in
      text
      content
      , not only in
      text
      details
      .

    Inbound bodies and history context

    OpenClaw separates the prompt body from the command body:

    • text
      BodyForAgent
      : primary model-facing text for the current message. Channel plugins should keep this focused on the sender's current prompt-bearing text.
    • text
      Body
      : legacy prompt fallback. This may include channel envelopes and optional history wrappers, but current channels should not rely on it as the primary model input when
      text
      BodyForAgent
      is available.
    • text
      CommandBody
      : raw user text for directive/command parsing.
    • text
      RawBody
      : legacy alias for
      text
      CommandBody
      (kept for compatibility).

    When a channel supplies history, it uses a shared wrapper:

    • text
      [Chat messages since your last reply - for context]
    • text
      [Current message - respond to this]

    For non-direct chats (groups/channels/rooms), the current message body is prefixed with the sender label (same style used for history entries). This keeps real-time and queued/history messages consistent in the agent prompt.

    History buffers are pending-only: they include group messages that did not trigger a run (for example, mention-gated messages) and exclude messages already in the session transcript.

    Directive stripping only applies to the current message section so history remains intact. Channels that wrap history should set

    text
    CommandBody
    (or
    text
    RawBody
    ) to the original message text and keep
    text
    Body
    as the combined prompt. Structured history, reply, forwarded, and channel metadata are rendered as user-role untrusted context blocks during prompt assembly. History buffers are configurable via
    text
    messages.groupChat.historyLimit
    (global default) and per-channel overrides like
    text
    channels.slack.historyLimit
    or
    text
    channels.telegram.accounts.<id>.historyLimit
    (set
    text
    0
    to disable).

    Queueing and followups

    If a run is already active, inbound messages can be queued, steered into the current run, or collected for a followup turn.

    • Configure via
      text
      messages.queue
      (and
      text
      messages.queue.byChannel
      ).
    • Default mode is
      text
      steer
      , with a 500ms followup debounce when steering falls back to queued followup delivery.
    • Modes:
      text
      steer
      ,
      text
      followup
      ,
      text
      collect
      ,
      text
      steer-backlog
      ,
      text
      interrupt
      , and the legacy one-at-a-time
      text
      queue
      mode.

    Details: Command queue and Steering queue.

    Channel run ownership

    Channel plugins may preserve ordering, debounce input, and apply transport backpressure before a message enters the session queue. They should not impose a separate timeout around the agent turn itself. Once a message is routed to a session, long-running work is governed by the session, tool, and runtime lifecycle so all channels report and recover from slow turns consistently.

    Streaming, chunking, and batching

    Block streaming sends partial replies as the model produces text blocks. Chunking respects channel text limits and avoids splitting fenced code.

    Key settings:

    • text
      agents.defaults.blockStreamingDefault
      (
      text
      on|off
      , default off)
    • text
      agents.defaults.blockStreamingBreak
      (
      text
      text_end|message_end
      )
    • text
      agents.defaults.blockStreamingChunk
      (
      text
      minChars|maxChars|breakPreference
      )
    • text
      agents.defaults.blockStreamingCoalesce
      (idle-based batching)
    • text
      agents.defaults.humanDelay
      (human-like pause between block replies)
    • Channel overrides:
      text
      *.blockStreaming
      and
      text
      *.blockStreamingCoalesce
      (non-Telegram channels require explicit
      text
      *.blockStreaming: true
      )

    Details: Streaming + chunking.

    Reasoning visibility and tokens

    OpenClaw can expose or hide model reasoning:

    • text
      /reasoning on|off|stream
      controls visibility.
    • Reasoning content still counts toward token usage when produced by the model.
    • Telegram supports reasoning stream into the draft bubble.

    Details: Thinking + reasoning directives and Token use.

    Prefixes, threading, and replies

    Outbound message formatting is centralized in

    text
    messages
    :

    • text
      messages.responsePrefix
      ,
      text
      channels.<channel>.responsePrefix
      , and
      text
      channels.<channel>.accounts.<id>.responsePrefix
      (outbound prefix cascade), plus
      text
      channels.whatsapp.messagePrefix
      (WhatsApp inbound prefix)
    • Reply threading via
      text
      replyToMode
      and per-channel defaults

    Details: Configuration and channel docs.

    Silent replies

    The exact silent token

    text
    NO_REPLY
    /
    text
    no_reply
    means “do not deliver a user-visible reply”. When a turn also has pending tool media, such as generated TTS audio, OpenClaw strips the silent text but still delivers the media attachment. OpenClaw resolves that behavior by conversation type:

    • Direct conversations disallow silence by default and rewrite a bare silent reply to a short visible fallback.
    • Groups/channels allow silence by default.
    • Internal orchestration allows silence by default.

    OpenClaw also uses silent replies for internal runner failures that happen before any assistant reply in non-direct chats, so groups/channels do not see gateway error boilerplate. Direct chats show compact failure copy by default; raw runner details are shown only when

    text
    /verbose
    is
    text
    on
    or
    text
    full
    .

    Defaults live under

    text
    agents.defaults.silentReply
    and
    text
    agents.defaults.silentReplyRewrite
    ;
    text
    surfaces.<id>.silentReply
    and
    text
    surfaces.<id>.silentReplyRewrite
    can override them per surface.

    When the parent session has one or more pending spawned subagent runs, bare silent replies are dropped on all surfaces instead of being rewritten, so the parent stays quiet until the child completion event delivers the real reply.

    Related

    • Streaming — real-time message delivery
    • Retry — message delivery retry behavior
    • Queue — message processing queue
    • Channels — messaging platform integrations

    © 2024 TaskFlow Mirror

    Powered by TaskFlow Sync Engine