Tencent Yuanbao is Tencent's AI assistant platform. The community-maintained apus-plugin-yuanbao plugin connects Yuanbao bots to Apus over WebSocket for direct messages and group chats.

Status: production-ready for bot DMs and group chats. WebSocket is the only supported connection mode. This plugin is maintained by the Tencent Yuanbao team as an external catalog entry, not by core Apus; the config/behavior details below (beyond install and the generic CLI surface) come from the plugin's own docs and are not verified against Apus core source.

Quick start

Requires Apus 2026.4.10 or above. Check with apus --version; upgrade with apus update.

apus channels add --channel yuanbao --token "appKey:appSecret"

apus channels login --channel yuanbao

apus pairing list yuanbao
apus pairing approve yuanbao <CODE>

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

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

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

{
  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)
    },
  },
}

1. Reset the App Secret in the Yuanbao app
2. Update the value in your config
3. Verify that hot reload applied the new credentials with apus channels status --probe.

Advanced configuration

Multiple accounts

{
  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,
        },
      },
    },
  },
}

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

Message limits

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

Streaming

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

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

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

Group chat history context

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

Controls how many historical messages are included in the AI context for group chats.

Reply-to mode

{
  channels: {
    yuanbao: {
      replyToMode: "first", // "off" | "first" | "all" (default: "first")
    },
  },
}

Markdown hint injection

By default, the bot injects a system-prompt instruction to prevent the model from wrapping the entire reply in a markdown code block.

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

Debug mode

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

Enables unsanitized log output for the listed bot IDs.

Multi-agent routing

Use bindings to route Yuanbao DMs or groups to different agents:

{
  agents: {
    ownership: "explicit",
    defaults: {
      heartbeat: { agentId: "main" },
      systemAgent: { agentId: "main" },
    },
    entries: {
      main: { workspace: "~/.apus/workspace" },
      "agent-a": { workspace: "/home/user/agent-a" },
      "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" },
      },
    },
    { agentId: "main", match: { channel: "yuanbao", accountId: "*" } },
  ],
  talk: { agentId: "main" },
}

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

Configuration reference

Full configuration: Gateway configuration

Supported message types

Receive: text, images, files, audio/voice, video, stickers/custom emoji, custom elements (link cards).

Send: text (markdown), images, files, audio, video, stickers.

Threads and replies: quote replies (configurable via replyToMode); thread replies are not supported by the 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