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

    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.

    Audio and voice notes

    Audio / Voice Notes (2026-01-17)

    What works

    • Media understanding (audio): If audio understanding is enabled (or auto‑detected), OpenClaw:
      1. Locates the first audio attachment (local path or URL) and downloads it if needed.
      2. Enforces
        text
        maxBytes
        before sending to each model entry.
      3. Runs the first eligible model entry in order (provider or CLI).
      4. If it fails or skips (size/timeout), it tries the next entry.
      5. On success, it replaces
        text
        Body
        with an
        text
        [Audio]
        block and sets
        text
        {{Transcript}}
        .
    • Command parsing: When transcription succeeds,
      text
      CommandBody
      /
      text
      RawBody
      are set to the transcript so slash commands still work.
    • Verbose logging: In
      text
      --verbose
      , we log when transcription runs and when it replaces the body.

    Auto-detection (default)

    If you don’t configure models and

    text
    tools.media.audio.enabled
    is not set to
    text
    false
    , OpenClaw auto-detects in this order and stops at the first working option:

    1. Active reply model when its provider supports audio understanding.
    2. Local CLIs (if installed)
      • text
        sherpa-onnx-offline
        (requires
        text
        SHERPA_ONNX_MODEL_DIR
        with encoder/decoder/joiner/tokens)
      • text
        whisper-cli
        (from
        text
        whisper-cpp
        ; uses
        text
        WHISPER_CPP_MODEL
        or the bundled tiny model)
      • text
        whisper
        (Python CLI; downloads models automatically)
    3. Gemini CLI (
      text
      gemini
      ) using
      text
      read_many_files
    4. Provider auth
      • Configured
        text
        models.providers.*
        entries that support audio are tried first
      • Bundled fallback order: OpenAI → Groq → xAI → Deepgram → Google → SenseAudio → ElevenLabs → Mistral

    To disable auto-detection, set

    text
    tools.media.audio.enabled: false
    . To customize, set
    text
    tools.media.audio.models
    . Note: Binary detection is best-effort across macOS/Linux/Windows; ensure the CLI is on
    text
    PATH
    (we expand
    text
    ~
    ), or set an explicit CLI model with a full command path.

    Config examples

    Provider + CLI fallback (OpenAI + Whisper CLI)

    json5
    { tools: { media: { audio: { enabled: true, maxBytes: 20971520, models: [ { provider: "openai", model: "gpt-4o-mini-transcribe" }, { type: "cli", command: "whisper", args: ["--model", "base", "{{MediaPath}}"], timeoutSeconds: 45, }, ], }, }, }, }

    Provider-only with scope gating

    json5
    { tools: { media: { audio: { enabled: true, scope: { default: "allow", rules: [{ action: "deny", match: { chatType: "group" } }], }, models: [{ provider: "openai", model: "gpt-4o-mini-transcribe" }], }, }, }, }

    Provider-only (Deepgram)

    json5
    { tools: { media: { audio: { enabled: true, models: [{ provider: "deepgram", model: "nova-3" }], }, }, }, }

    Provider-only (Mistral Voxtral)

    json5
    { tools: { media: { audio: { enabled: true, models: [{ provider: "mistral", model: "voxtral-mini-latest" }], }, }, }, }

    Provider-only (SenseAudio)

    json5
    { tools: { media: { audio: { enabled: true, models: [{ provider: "senseaudio", model: "senseaudio-asr-pro-1.5-260319" }], }, }, }, }

    Echo transcript to chat (opt-in)

    json5
    { tools: { media: { audio: { enabled: true, echoTranscript: true, // default is false echoFormat: '📝 "{transcript}"', // optional, supports {transcript} models: [{ provider: "openai", model: "gpt-4o-mini-transcribe" }], }, }, }, }

    Notes & limits

    • Provider auth follows the standard model auth order (auth profiles, env vars,
      text
      models.providers.*.apiKey
      ).
    • Groq setup details: Groq.
    • Deepgram picks up
      text
      DEEPGRAM_API_KEY
      when
      text
      provider: "deepgram"
      is used.
    • Deepgram setup details: Deepgram (audio transcription).
    • Mistral setup details: Mistral.
    • SenseAudio picks up
      text
      SENSEAUDIO_API_KEY
      when
      text
      provider: "senseaudio"
      is used.
    • SenseAudio setup details: SenseAudio.
    • Audio providers can override
      text
      baseUrl
      ,
      text
      headers
      , and
      text
      providerOptions
      via
      text
      tools.media.audio
      .
    • Default size cap is 20MB (
      text
      tools.media.audio.maxBytes
      ). Oversize audio is skipped for that model and the next entry is tried.
    • Tiny/empty audio files below 1024 bytes are skipped before provider/CLI transcription.
    • Default
      text
      maxChars
      for audio is unset (full transcript). Set
      text
      tools.media.audio.maxChars
      or per-entry
      text
      maxChars
      to trim output.
    • OpenAI auto default is
      text
      gpt-4o-mini-transcribe
      ; set
      text
      model: "gpt-4o-transcribe"
      for higher accuracy.
    • Use
      text
      tools.media.audio.attachments
      to process multiple voice notes (
      text
      mode: "all"
      +
      text
      maxAttachments
      ).
    • Transcript is available to templates as
      text
      {{Transcript}}
      .
    • text
      tools.media.audio.echoTranscript
      is off by default; enable it to send transcript confirmation back to the originating chat before agent processing.
    • text
      tools.media.audio.echoFormat
      customizes the echo text (placeholder:
      text
      {transcript}
      ).
    • CLI stdout is capped (5MB); keep CLI output concise.
    • CLI
      text
      args
      should use
      text
      {{MediaPath}}
      for the local audio file path. Run
      text
      openclaw doctor --fix
      to migrate deprecated
      text
      {input}
      placeholders from older
      text
      audio.transcription.command
      configs.

    Proxy environment support

    Provider-based audio transcription honors standard outbound proxy env vars:

    • text
      HTTPS_PROXY
    • text
      HTTP_PROXY
    • text
      ALL_PROXY
    • text
      https_proxy
    • text
      http_proxy
    • text
      all_proxy

    If no proxy env vars are set, direct egress is used. If proxy config is malformed, OpenClaw logs a warning and falls back to direct fetch.

    Mention detection in groups

    When

    text
    requireMention: true
    is set for a group chat, OpenClaw now transcribes audio before checking for mentions. This allows voice notes to be processed even when they contain mentions.

    How it works:

    1. If a voice message has no text body and the group requires mentions, OpenClaw performs a "preflight" transcription.
    2. The transcript is checked for mention patterns (e.g.,
      text
      @BotName
      , emoji triggers).
    3. If a mention is found, the message proceeds through the full reply pipeline.
    4. The transcript is used for mention detection so voice notes can pass the mention gate.

    Fallback behavior:

    • If transcription fails during preflight (timeout, API error, etc.), the message is processed based on text-only mention detection.
    • This ensures that mixed messages (text + audio) are never incorrectly dropped.

    Opt-out per Telegram group/topic:

    • Set
      text
      channels.telegram.groups.<chatId>.disableAudioPreflight: true
      to skip preflight transcript mention checks for that group.
    • Set
      text
      channels.telegram.groups.<chatId>.topics.<threadId>.disableAudioPreflight
      to override per-topic (
      text
      true
      to skip,
      text
      false
      to force-enable).
    • Default is
      text
      false
      (preflight enabled when mention-gated conditions match).

    Example: A user sends a voice note saying "Hey @Claude, what's the weather?" in a Telegram group with

    text
    requireMention: true
    . The voice note is transcribed, the mention is detected, and the agent replies.

    Gotchas

    • Scope rules use first-match wins.
      text
      chatType
      is normalized to
      text
      direct
      ,
      text
      group
      , or
      text
      room
      .
    • Ensure your CLI exits 0 and prints plain text; JSON needs to be massaged via
      text
      jq -r .text
      .
    • For
      text
      parakeet-mlx
      , if you pass
      text
      --output-dir
      , OpenClaw reads
      text
      <output-dir>/<media-basename>.txt
      when
      text
      --output-format
      is
      text
      txt
      (or omitted); non-
      text
      txt
      output formats fall back to stdout parsing.
    • Keep timeouts reasonable (
      text
      timeoutSeconds
      , default 60s) to avoid blocking the reply queue.
    • Preflight transcription only processes the first audio attachment for mention detection. Additional audio is processed during the main media understanding phase.

    Related

    • Media understanding
    • Talk mode
    • Voice wake

    © 2024 TaskFlow Mirror

    Powered by TaskFlow Sync Engine

    Real-time Synchronized Documentation

    Last sync: 01/05/2026 07:02:50

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