AILIVE文档
API 参考

API 参考

直播间接入、平台数据、播出反馈与音视频接收的客户端开放接口。

接口参考从当前后端生成的 OpenAPI 3.1 契约构建,参数与响应随契约更新。客户端接入一个直播间,可以跨场次保持连接。

接入顺序

  1. 在工作台创建直播间,取得直播间接入 Key。
  2. 申请连接,显示核对码,由直播间所有者或管理员审批。
  3. 按响应的轮询间隔领取令牌,再读取直播间。
  4. 登记平台来源,推送平台数据。
  5. 按需读取播出反馈与音视频接收凭据。
  6. 不再接入时撤销本连接。撤销连接与停止直播是不同操作。

权限与边界

接入仅代表获批的直播间,按批准的 scopes 使用。客户端不控制直播:开播、停播、播报、打断和动作均在工作台中控台操作。工作台、管理端和支付回调不在这份客户端参考中。

接口页只展示占位符示例,不收集真实令牌或提供在线请求代理。接入 QA 时使用 https://api.qa.evermuse.cn;正式入口为 https://api.ailive.studio。

错误与重试

错误正文为 error 对象,包含 code、message、requestId 和 details。轮询结果位于 details.error:待审批时按间隔继续,slow_down 时放慢,被拒绝或过期则结束本次申请。

遇到 401/403 检查凭据、审批和权限;429 时降低频率。平台数据重发保留相同 batchId;刷新令牌串行处理,结果未知时不要重复使用旧 Refresh Token。反馈问题时提供错误编号和时间,勿发送完整 Key 或令牌。

本页目录