接入文档
REST API 直调 · MCP · Skill 一键安装
Vox CLI
一行命令把文本变成 mp3 URL。零运行时依赖(不需要 Node / Python), 二进制单文件,跨平台。跟 REST / MCP / Skill 共享同一组业务函数:tts /voices /balance。
安装
macOS / Linux:
curl -fsSL https://vox.timor419.com/install.sh | sh
自动检测 OS / 架构,从 Vox CDN 拉对应二进制装到 /usr/local/bin/vox。 想装到别的地方:VOX_INSTALL_DIR=$HOME/bin curl … | sh。
Windows:
直接下载 https://oss.timor419.com/tts/cli/latest/windows-amd64/vox.exe 重命名为 vox.exe 并加到 PATH。
登录
首次使用先登录——浏览器自动打开授权页面,点「授权」即可:
vox login
授权通过后 API key 保存在 ~/.vox/config.toml (chmod 600)。也支持环境变量 VOX_API_KEY(优先级高于配置文件)。
清除登录态:vox logout。
命令
vox tts
合成文本,默认打印 mp3 URL 到 stdout(管道友好)
vox tts "你好,世界"
vox tts "你好" --voice 云楚灵
vox tts "你好" -o hello.mp3
vox tts "你好" --json
vox voices
列出可用音色(精选 ★ 优先排列)
vox voices
vox voices --json
vox balance
查询账户余额(零扣费)
vox balance
跟其他接口的对应关系
Vox 有 4 个用户接口,全部对齐到同一组业务函数。CLI 只是 REST 的薄壳。
| 函数 | REST | MCP tool | CLI |
|---|---|---|---|
| tts | POST /api/v1/tts | tts | vox tts |
| voices | GET /api/v1/voices | voices | vox voices |
| balance | GET /api/v1/balance | balance | vox balance |
常见问题
能在 CI / 脚本里用吗?
可以。设置环境变量 VOX_API_KEY 即可,无需交互登录。vox tts ... --json 的输出适合配 jq 处理。
合成后的 mp3 多久过期?
目前 Vox CDN 上的 output 永久保留。后续如果加 lifecycle 策略会在文档里同步说明。
怎么升级?
重跑安装命令即可(覆盖旧的二进制)。或手动 curl 最新二进制覆盖。
相关链接
- REST API 文档:https://vox.timor419.com/docs/rest
- MCP 文档:https://vox.timor419.com/docs/mcp
- Skill 安装:https://vox.timor419.com/docs/skill
- 获取 API key:https://vox.timor419.com/get-key