Admin 接口 API 文档

May 23, 2026 · View on GitHub

基础路径:http://<host>:<listenport>


1. 获取全局配置

GET /api/admin/config

返回服务启动时的全局配置参数(来自 CLI 参数)。

请求参数: 无

响应:

{
  "code": 0,
  "msg": "ok",
  "data": {
    "config": {
      "fps": 25,
      "l": 10,
      "m": 8,
      "r": 10,
      "model": "wav2lip",
      "avatar_id": "wav2lip256_avatar1",
      "data_path": "data/avatars",
      "batch_size": 16,
      "modelres": 192,
      "modelfile": "",
      "customvideo_config": "",
      "tts": "edgetts",
      "REF_FILE": "zh-CN-YunxiaNeural",
      "REF_TEXT": null,
      "TTS_SERVER": "http://127.0.0.1:9880",
      "transport": "webrtc",
      "push_url": "http://localhost:1985/rtc/v1/whip/?app=live&stream=livestream",
      "max_session": 1,
      "listenport": 8010,
      "customopt": []
    }
  }
}

配置字段说明

字段类型默认值说明
fpsint25视频帧率
lint10音频缓冲参数
mint8音频缓冲参数
rint10音频缓冲参数
modelstring"wav2lip"Avatar 模型:musetalk / wav2lip / ultralight
avatar_idstring"wav2lip256_avatar1"默认 Avatar 标识
data_pathstring"data/avatars"Avatar 数据目录
batch_sizeint16推理批大小
modelresint192模型分辨率
modelfilestring""自定义模型文件路径
customvideo_configstring""自定义动作 JSON 文件路径
ttsstring"edgetts"TTS 插件
REF_FILEstring"zh-CN-YunxiaNeural"TTS 参考文件或语音模型ID
REF_TEXTstringnullTTS 参考文本
TTS_SERVERstring"http://127.0.0.1:9880"TTS 服务地址
transportstring"webrtc"输出传输方式:rtcpush / webrtc / rtmp / virtualcam
push_urlstringRTCPush 目标地址
max_sessionint1最大会话数
listenportint8010HTTP 监听端口
customoptarray[]自定义动作配置(已解析)

2. 获取活跃会话列表

GET /api/admin/sessions

返回当前所有活跃会话及其状态和配置。

请求参数: 无

响应:

{
  "code": 0,
  "msg": "ok",
  "data": {
    "sessions": [
      {
        "sessionid": "uuid-string",
        "speaking": true,
        "recording": false,
        "model": "musetalk",
        "avatar_id": "avatar1",
        "REF_FILE": "zh-CN-YunxiaNeural",
        "transport": "webrtc",
        "batch_size": 16,
        "customopt": []
      }
    ]
  }
}

会话字段说明

字段类型说明
sessionidstring会话唯一标识
speakingbool当前是否正在说话
recordingbool当前是否正在录制
modelstring会话使用的 Avatar 模型
avatar_idstring会话使用的 Avatar 标识
REF_FILEstringTTS 参考文件/模型ID
transportstring传输方式
batch_sizeint推理批大小
customoptarray自定义动作配置