用途:通过 Inbox Zero 公开 API 检查或修改 Inbox Zero 状态,包括查看 API schema、列出与管理自动化规则、读取收件箱分析数据。
主要能力:支持 rules 列表与增改、按周期查询统计(stats by-period)、获取 openapi schema。建议加 --json 以获得稳定、可机器读取的输出。
使用方式:认证命令(rules、stats 等)需将凭据放入 INBOX_ZERO_API_KEY 或 OpenClaw 技能配置,避免用 CLI 参数传 API key。创建或替换规则前先用 inbox-zero-api openapi --json 获取实时 schema(无需 API key)。创建与更新时把 JSON 写入工作区文件或用 stdin 管道传入。更新规则为整体替换,只想改部分内容时应先读取当前规则。自托管或非标准部署可用 INBOX_ZERO_BASE_URL 或 inbox-zero-api config set base-url <url>。OpenClaw 配置在 ~/.openclaw/openclaw.json 的 skills.entries.inboxZeroApi.apiKey 设置 key,或在主机环境导出 INBOX_ZERO_API_KEY。
快速开始: inbox-zero-api rules list --json inbox-zero-api stats by-period --period week --json inbox-zero-api openapi --json
未安装时可使用 OpenClaw 安装器,或运行 npm install -g @inbox-zero/api;也可用 npx @inbox-zero/api。
限制:需自行准备 API key;规则更新为全量替换;除自托管外通常无需改 base-url。其余细节资料暂未提供。