文档索引
虚拟主播平台的文档都在这里,浏览器打开 /docs 可以直接看(表格、代码块都会正常渲染)。
| 文档 | 给谁看 | 什么时候看 |
|---|---|---|
| 平台使用说明 | 你 / 运营 | 第一次上手先看这个:后台五个页签每个字段是干什么的、常见问题怎么排查 |
| 第三方 API 接入 | 要对接的合作方 | 对方要嵌直播间、让主播说话、查状态时 |
| 弹幕接入 | 有自己直播间的合作方 | 要把 B 站/抖音/自有 App 的弹幕接进来,并把 AI 的回复拿回去 |
| 后台接口参考 | 运维 / 自动化脚本 | 想用脚本批量操作后台(改配置、开播、生成节目单)时 |
| 公网部署 | 你 / 运维 | 要给外网第三方用,需要 https + wss + 放行端口时 |
三条快速入口
- 运营后台:
/admin - 观众端首页:
/ - 接口定义(机器可读):
/v1/openapi.json
一句话记住三件事
- 观众页走
/api/*,不需要 API Key; - 第三方走
/v1/*,要 API Key,且每个主播可以单独开关、单独发一把 Key; - 后台的写操作(POST/PUT/DELETE)在配了
ADMIN_TOKEN时需要口令,读操作不需要。