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:28

    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.

    Android app

    note

    The Android app has not been publicly released yet. The source code is available in the [OpenClaw repository](https://github.com/openclaw/openclaw) under `apps/android`. You can build it yourself using Java 17 and the Android SDK (`./gradlew :app:assemblePlayDebug`). See [apps/android/README.md](https://github.com/openclaw/openclaw/blob/main/apps/android/README.md) for build instructions.

    Support snapshot

    • Role: companion node app (Android does not host the Gateway).
    • Gateway required: yes (run it on macOS, Linux, or Windows via WSL2).
    • Install: Getting Started + Pairing.
    • Gateway: Runbook + Configuration.
      • Protocols: Gateway protocol (nodes + control plane).

    System control

    System control (launchd/systemd) lives on the Gateway host. See Gateway.

    Connection runbook

    Android node app ⇄ (mDNS/NSD + WebSocket) ⇄ Gateway

    Android connects directly to the Gateway WebSocket and uses device pairing (

    text
    role: node
    ).

    For Tailscale or public hosts, Android requires a secure endpoint:

    • Preferred: Tailscale Serve / Funnel with
      text
      https://<magicdns>
      /
      text
      wss://<magicdns>
    • Also supported: any other
      text
      wss://
      Gateway URL with a real TLS endpoint
    • Cleartext
      text
      ws://
      remains supported on private LAN addresses /
      text
      .local
      hosts, plus
      text
      localhost
      ,
      text
      127.0.0.1
      , and the Android emulator bridge (
      text
      10.0.2.2
      )

    Prerequisites

    • You can run the Gateway on the “master” machine.
    • Android device/emulator can reach the gateway WebSocket:
      • Same LAN with mDNS/NSD, or
      • Same Tailscale tailnet using Wide-Area Bonjour / unicast DNS-SD (see below), or
      • Manual gateway host/port (fallback)
    • Tailnet/public mobile pairing does not use raw tailnet IP
      text
      ws://
      endpoints. Use Tailscale Serve or another
      text
      wss://
      URL instead.
    • You can run the CLI (
      text
      openclaw
      ) on the gateway machine (or via SSH).

    1) Start the Gateway

    bash
    openclaw gateway --port 18789 --verbose

    Confirm in logs you see something like:

    • text
      listening on ws://0.0.0.0:18789

    For remote Android access over Tailscale, prefer Serve/Funnel instead of a raw tailnet bind:

    bash
    openclaw gateway --tailscale serve

    This gives Android a secure

    text
    wss://
    /
    text
    https://
    endpoint. A plain
    text
    gateway.bind: "tailnet"
    setup is not enough for first-time remote Android pairing unless you also terminate TLS separately.

    2) Verify discovery (optional)

    From the gateway machine:

    bash
    dns-sd -B _openclaw-gw._tcp local.

    More debugging notes: Bonjour.

    If you also configured a wide-area discovery domain, compare against:

    bash
    openclaw gateway discover --json

    That shows

    text
    local.
    plus the configured wide-area domain in one pass and uses the resolved service endpoint instead of TXT-only hints.

    Tailnet (Vienna ⇄ London) discovery via unicast DNS-SD

    Android NSD/mDNS discovery won’t cross networks. If your Android node and the gateway are on different networks but connected via Tailscale, use Wide-Area Bonjour / unicast DNS-SD instead.

    Discovery alone is not sufficient for tailnet/public Android pairing. The discovered route still needs a secure endpoint (

    text
    wss://
    or Tailscale Serve):

    1. Set up a DNS-SD zone (example
      text
      openclaw.internal.
      ) on the gateway host and publish
      text
      _openclaw-gw._tcp
      records.
    2. Configure Tailscale split DNS for your chosen domain pointing at that DNS server.

    Details and example CoreDNS config: Bonjour.

    3) Connect from Android

    In the Android app:

    • The app keeps its gateway connection alive via a foreground service (persistent notification).
    • Open the Connect tab.
    • Use Setup Code or Manual mode.
    • If discovery is blocked, use manual host/port in Advanced controls. For private LAN hosts,
      text
      ws://
      still works. For Tailscale/public hosts, turn on TLS and use a
      text
      wss://
      / Tailscale Serve endpoint.

    After the first successful pairing, Android auto-reconnects on launch:

    • Manual endpoint (if enabled), otherwise
    • The last discovered gateway (best-effort).

    Presence alive beacons

    After the authenticated node session connects, and when the app moves to the background while the foreground service is still connected, Android calls

    text
    node.event
    with
    text
    event: "node.presence.alive"
    . The gateway records this as
    text
    lastSeenAtMs
    /
    text
    lastSeenReason
    on the paired node/device metadata only after the authenticated node device identity is known.

    The app counts the beacon as successfully recorded only when the gateway response includes

    text
    handled: true
    . Older gateways may acknowledge
    text
    node.event
    with
    text
    { "ok": true }
    ; that response is compatible but does not count as a durable last-seen update.

    4) Approve pairing (CLI)

    On the gateway machine:

    bash
    openclaw devices list openclaw devices approve <requestId> openclaw devices reject <requestId>

    Pairing details: Pairing.

    Optional: if the Android node always connects from a tightly controlled subnet, you can opt in to first-time node auto-approval with explicit CIDRs or exact IPs:

    json5
    { gateway: { nodes: { pairing: { autoApproveCidrs: ["192.168.1.0/24"], }, }, }, }

    This is disabled by default. It applies only to fresh

    text
    role: node
    pairing with no requested scopes. Operator/browser pairing and any role, scope, metadata, or public-key change still require manual approval.

    5) Verify the node is connected

    • Via nodes status:

      bash
      openclaw nodes status
    • Via Gateway:

      bash
      openclaw gateway call node.list --params "{}"

    6) Chat + history

    The Android Chat tab supports session selection (default

    text
    main
    , plus other existing sessions):

    • History:
      text
      chat.history
      (display-normalized; inline directive tags are stripped from visible text, plain-text tool-call XML payloads (including
      text
      <tool_call>...</tool_call>
      ,
      text
      <function_call>...</function_call>
      ,
      text
      <tool_calls>...</tool_calls>
      ,
      text
      <function_calls>...</function_calls>
      , and truncated tool-call blocks) and leaked ASCII/full-width model control tokens are stripped, pure silent-token assistant rows such as exact
      text
      NO_REPLY
      /
      text
      no_reply
      are omitted, and oversized rows can be replaced with placeholders)
    • Send:
      text
      chat.send
    • Push updates (best-effort):
      text
      chat.subscribe
      →
      text
      event:"chat"

    7) Canvas + camera

    Gateway Canvas Host (recommended for web content)

    If you want the node to show real HTML/CSS/JS that the agent can edit on disk, point the node at the Gateway canvas host.

    note

    Nodes load canvas from the Gateway HTTP server (same port as `gateway.port`, default `18789`).
    1. Create

      text
      ~/.openclaw/workspace/canvas/index.html
      on the gateway host.

    2. Navigate the node to it (LAN):

    bash
    openclaw nodes invoke --node "<Android Node>" --command canvas.navigate --params '{"url":"http://<gateway-hostname>.local:18789/__openclaw__/canvas/"}'

    Tailnet (optional): if both devices are on Tailscale, use a MagicDNS name or tailnet IP instead of

    text
    .local
    , e.g.
    text
    http://<gateway-magicdns>:18789/__openclaw__/canvas/
    .

    This server injects a live-reload client into HTML and reloads on file changes. The A2UI host lives at

    text
    http://<gateway-host>:18789/__openclaw__/a2ui/
    .

    Canvas commands (foreground only):

    • text
      canvas.eval
      ,
      text
      canvas.snapshot
      ,
      text
      canvas.navigate
      (use
      text
      {"url":""}
      or
      text
      {"url":"/"}
      to return to the default scaffold).
      text
      canvas.snapshot
      returns
      text
      { format, base64 }
      (default
      text
      format="jpeg"
      ).
    • A2UI:
      text
      canvas.a2ui.push
      ,
      text
      canvas.a2ui.reset
      (
      text
      canvas.a2ui.pushJSONL
      legacy alias)

    Camera commands (foreground only; permission-gated):

    • text
      camera.snap
      (jpg)
    • text
      camera.clip
      (mp4)

    See Camera node for parameters and CLI helpers.

    8) Voice + expanded Android command surface

    • Voice tab: Android has two explicit capture modes. Mic is a manual Voice-tab session that sends each pause as a chat turn and stops when the app leaves the foreground or the user leaves the Voice tab. Talk is continuous Talk Mode and keeps listening until toggled off or the node disconnects.
    • Talk Mode promotes the existing foreground service from
      text
      dataSync
      to
      text
      dataSync|microphone
      before capture starts, then demotes it when Talk Mode stops. Android 14+ requires the
      text
      FOREGROUND_SERVICE_MICROPHONE
      declaration, the
      text
      RECORD_AUDIO
      runtime grant, and the microphone service type at runtime.
    • Spoken replies use
      text
      talk.speak
      through the configured gateway Talk provider. Local system TTS is used only when
      text
      talk.speak
      is unavailable.
    • Voice wake remains disabled in the Android UX/runtime.
    • Additional Android command families (availability depends on device + permissions):
      • text
        device.status
        ,
        text
        device.info
        ,
        text
        device.permissions
        ,
        text
        device.health
      • text
        notifications.list
        ,
        text
        notifications.actions
        (see Notification forwarding below)
      • text
        photos.latest
      • text
        contacts.search
        ,
        text
        contacts.add
      • text
        calendar.events
        ,
        text
        calendar.add
      • text
        callLog.search
      • text
        sms.search
      • text
        motion.activity
        ,
        text
        motion.pedometer

    Assistant entrypoints

    Android supports launching OpenClaw from the system assistant trigger (Google Assistant). When configured, holding the home button or saying "Hey Google, ask OpenClaw..." opens the app and hands the prompt into the chat composer.

    This uses Android App Actions metadata declared in the app manifest. No extra configuration is needed on the gateway side -- the assistant intent is handled entirely by the Android app and forwarded as a normal chat message.

    note

    App Actions availability depends on the device, Google Play Services version, and whether the user has set OpenClaw as the default assistant app.

    Notification forwarding

    Android can forward device notifications to the gateway as events. Several controls let you scope which notifications are forwarded and when.

    KeyTypeDescription
    text
    notifications.allowPackages
    string[]Only forward notifications from these package names. If set, all other packages are ignored.
    text
    notifications.denyPackages
    string[]Never forward notifications from these package names. Applied after
    text
    allowPackages
    .
    text
    notifications.quietHours.start
    string (HH:mm)Start of quiet hours window (local device time). Notifications are suppressed during this window.
    text
    notifications.quietHours.end
    string (HH:mm)End of quiet hours window.
    text
    notifications.rateLimit
    numberMaximum forwarded notifications per package per minute. Excess notifications are dropped.

    The notification picker also uses safer behavior for forwarded notification events, preventing accidental forwarding of sensitive system notifications.

    Example configuration:

    json5
    { notifications: { allowPackages: ["com.slack", "com.whatsapp"], denyPackages: ["com.android.systemui"], quietHours: { start: "22:00", end: "07:00", }, rateLimit: 5, }, }

    note

    Notification forwarding requires the Android Notification Listener permission. The app prompts for this during setup.

    Related

    • iOS app
    • Nodes
    • Android node troubleshooting

    © 2024 TaskFlow Mirror

    Powered by TaskFlow Sync Engine