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:05:24

    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.

    Yuanbao

    Yuanbao

    Tencent Yuanbao is Tencent's AI assistant platform. The OpenClaw channel plugin connects Yuanbao bots to OpenClaw over WebSocket so they can interact with users through direct messages and group chats.

    Status: production-ready for bot DMs + group chats. WebSocket is the only supported connection mode.


    Quick start

    Requires OpenClaw 2026.4.10 or above. Run

    text
    openclaw --version
    to check. Upgrade with
    text
    openclaw update
    .

    Add the Yuanbao channel with your credentials

    ```bash} openclaw channels add --channel yuanbao --token "appKey:appSecret" ```
    text
    The `--token` value uses colon-separated `appKey:appSecret` format. You can obtain these from the Yuanbao app by creating a robot in your application settings.

    After setup completes, restart the gateway to apply the changes

    ```bash} openclaw gateway restart ```

    Interactive setup (alternative)

    You can also use the interactive wizard:

    bash
    openclaw channels login --channel yuanbao

    Follow the prompts to enter your App ID and App Secret.


    Access control

    Direct messages

    Configure

    text
    dmPolicy
    to control who can DM the bot:

    • text
      "pairing"
      — unknown users receive a pairing code; approve via CLI
    • text
      "allowlist"
      — only users listed in
      text
      allowFrom
      can chat
    • text
      "open"
      — allow all users (default)
    • text
      "disabled"
      — disable all DMs

    Approve a pairing request:

    bash
    openclaw pairing list yuanbao openclaw pairing approve yuanbao <CODE>

    Group chats

    Mention requirement (

    text
    channels.yuanbao.requireMention
    ):

    • text
      true
      — require @mention (default)
    • text
      false
      — respond without @mention

    Replying to the bot's message in a group chat is treated as an implicit mention.


    Configuration examples

    Basic setup with open DM policy

    json5
    { channels: { yuanbao: { appKey: "your_app_key", appSecret: "your_app_secret", dm: { policy: "open", }, }, }, }

    Restrict DMs to specific users

    json5
    { channels: { yuanbao: { appKey: "your_app_key", appSecret: "your_app_secret", dm: { policy: "allowlist", allowFrom: ["user_id_1", "user_id_2"], }, }, }, }

    Disable @mention requirement in groups

    json5
    { channels: { yuanbao: { requireMention: false, }, }, }

    Optimize outbound message delivery

    json5
    { channels: { yuanbao: { // Send each chunk immediately without buffering outboundQueueStrategy: "immediate", }, }, }

    Tune merge-text strategy

    json5
    { channels: { yuanbao: { outboundQueueStrategy: "merge-text", minChars: 2800, // buffer until this many chars maxChars: 3000, // force split above this limit idleMs: 5000, // auto-flush after idle timeout (ms) }, }, }

    Common commands

    CommandDescription
    text
    /help
    Show available commands
    text
    /status
    Show bot status
    text
    /new
    Start a new session
    text
    /stop
    Stop the current run
    text
    /restart
    Restart OpenClaw
    text
    /compact
    Compact the session context

    Yuanbao supports native slash-command menus. Commands are synced to the platform automatically when the gateway starts.


    Troubleshooting

    Bot does not respond in group chats

    1. Ensure the bot is added to the group
    2. Ensure you @mention the bot (required by default)
    3. Check logs:
      text
      openclaw logs --follow

    Bot does not receive messages

    1. Ensure the bot is created and approved in the Yuanbao app
    2. Ensure
      text
      appKey
      and
      text
      appSecret
      are correctly configured
    3. Ensure the gateway is running:
      text
      openclaw gateway status
    4. Check logs:
      text
      openclaw logs --follow

    Bot sends empty or fallback replies

    1. Check if the AI model is returning valid content
    2. The default fallback reply is: "暂时无法解答,你可以换个问题问问我哦"
    3. Customize it via
      text
      channels.yuanbao.fallbackReply

    App Secret leaked

    1. Reset the App Secret in YuanBao APP
    2. Update the value in your config
    3. Restart the gateway:
      text
      openclaw gateway restart

    Advanced configuration

    Multiple accounts

    json5
    { channels: { yuanbao: { defaultAccount: "main", accounts: { main: { appKey: "key_xxx", appSecret: "secret_xxx", name: "Primary bot", }, backup: { appKey: "key_yyy", appSecret: "secret_yyy", name: "Backup bot", enabled: false, }, }, }, }, }

    text
    defaultAccount
    controls which account is used when outbound APIs do not specify an
    text
    accountId
    .

    Message limits

    • text
      maxChars
      — single message max character count (default:
      text
      3000
      chars)
    • text
      mediaMaxMb
      — media upload/download limit (default:
      text
      20
      MB)
    • text
      overflowPolicy
      — behavior when message exceeds limit:
      text
      "split"
      (default) or
      text
      "stop"

    Streaming

    Yuanbao supports block-level streaming output. When enabled, the bot sends text in chunks as it generates.

    json5
    { channels: { yuanbao: { disableBlockStreaming: false, // block streaming enabled (default) }, }, }

    Set

    text
    disableBlockStreaming: true
    to send the complete reply in one message.

    Group chat history context

    Control how many historical messages are included in the AI context for group chats:

    json5
    { channels: { yuanbao: { historyLimit: 100, // default: 100, set 0 to disable }, }, }

    Reply-to mode

    Control how the bot quotes messages when replying in group chats:

    json5
    { channels: { yuanbao: { replyToMode: "first", // "off" | "first" | "all" (default: "first") }, }, }
    ValueBehavior
    text
    "off"
    No quote reply
    text
    "first"
    Quote only the first reply per inbound message (default)
    text
    "all"
    Quote every reply

    Markdown hint injection

    By default, the bot injects instructions in the system prompt to prevent the AI model from wrapping the entire reply in markdown code blocks.

    json5
    { channels: { yuanbao: { markdownHintEnabled: true, // default: true }, }, }

    Debug mode

    Enable unsanitized log output for specific bot IDs:

    json5
    { channels: { yuanbao: { debugBotIds: ["bot_user_id_1", "bot_user_id_2"], }, }, }

    Multi-agent routing

    Use

    text
    bindings
    to route Yuanbao DMs or groups to different agents.

    json5
    { agents: { list: [ { id: "main" }, { id: "agent-a", workspace: "/home/user/agent-a" }, { id: "agent-b", workspace: "/home/user/agent-b" }, ], }, bindings: [ { agentId: "agent-a", match: { channel: "yuanbao", peer: { kind: "direct", id: "user_xxx" }, }, }, { agentId: "agent-b", match: { channel: "yuanbao", peer: { kind: "group", id: "group_zzz" }, }, }, ], }

    Routing fields:

    • text
      match.channel
      :
      text
      "yuanbao"
    • text
      match.peer.kind
      :
      text
      "direct"
      (DM) or
      text
      "group"
      (group chat)
    • text
      match.peer.id
      : user ID or group code

    Configuration reference

    Full configuration: Gateway configuration

    SettingDescriptionDefault
    text
    channels.yuanbao.enabled
    Enable/disable the channel
    text
    true
    text
    channels.yuanbao.defaultAccount
    Default account for outbound routing
    text
    default
    text
    channels.yuanbao.accounts.<id>.appKey
    App Key (used for signing and ticket generation)—
    text
    channels.yuanbao.accounts.<id>.appSecret
    App Secret (used for signing)—
    text
    channels.yuanbao.accounts.<id>.token
    Pre-signed token (skips automatic ticket signing)—
    text
    channels.yuanbao.accounts.<id>.name
    Account display name—
    text
    channels.yuanbao.accounts.<id>.enabled
    Enable/disable a specific account
    text
    true
    text
    channels.yuanbao.dm.policy
    DM policy
    text
    open
    text
    channels.yuanbao.dm.allowFrom
    DM allowlist (user ID list)—
    text
    channels.yuanbao.requireMention
    Require @mention in groups
    text
    true
    text
    channels.yuanbao.overflowPolicy
    Long message handling (
    text
    split
    or
    text
    stop
    )
    text
    split
    text
    channels.yuanbao.replyToMode
    Group reply-to strategy (
    text
    off
    ,
    text
    first
    ,
    text
    all
    )
    text
    first
    text
    channels.yuanbao.outboundQueueStrategy
    Outbound strategy (
    text
    merge-text
    or
    text
    immediate
    )
    text
    merge-text
    text
    channels.yuanbao.minChars
    Merge-text: min chars to trigger send
    text
    2800
    text
    channels.yuanbao.maxChars
    Merge-text: max chars per message
    text
    3000
    text
    channels.yuanbao.idleMs
    Merge-text: idle timeout before auto-flush (ms)
    text
    5000
    text
    channels.yuanbao.mediaMaxMb
    Media size limit (MB)
    text
    20
    text
    channels.yuanbao.historyLimit
    Group chat history context entries
    text
    100
    text
    channels.yuanbao.disableBlockStreaming
    Disable block-level streaming output
    text
    false
    text
    channels.yuanbao.fallbackReply
    Fallback reply when AI returns no content
    text
    暂时无法解答,你可以换个问题问问我哦
    text
    channels.yuanbao.markdownHintEnabled
    Inject markdown anti-wrapping instructions
    text
    true
    text
    channels.yuanbao.debugBotIds
    Debug whitelist bot IDs (unsanitized logs)
    text
    []

    Supported message types

    Receive

    • ✅ Text
    • ✅ Images
    • ✅ Files
    • ✅ Audio / Voice
    • ✅ Video
    • ✅ Stickers / Custom emoji
    • ✅ Custom elements (link cards, etc.)

    Send

    • ✅ Text (with markdown support)
    • ✅ Images
    • ✅ Files
    • ✅ Audio
    • ✅ Video
    • ✅ Stickers

    Threads and replies

    • ✅ Quote replies (configurable via
      text
      replyToMode
      )
    • ❌ Thread replies (not supported by platform)

    Related

    • Channels Overview — all supported channels
    • Pairing — DM authentication and pairing flow
    • Groups — group chat behavior and mention gating
    • Channel Routing — session routing for messages
    • Security — access model and hardening

    © 2024 TaskFlow Mirror

    Powered by TaskFlow Sync Engine