Skip to main content
Version: Latest

Start Session

使用会话令牌启动交互式头像会话。通过响应中的 livekit.url 与 livekit.token 连接实时视频流。

什么是 LiveKit?​

LiveKit 是基于 WebRTC 的实时视频流基础设施。Start Session 返回 livekit.url、livekit.token 与 room_name 后,客户端可调用 room.connect(url, token) 等方法连接 LiveKit 服务器。连接成功后,头像的视频、音频与数据通道将实时传输,实现对话式体验。

POST /api/v2/sessions/start

Headers​

请求头值
AuthorizationBearer {session_token}
Content-Typeapplication/json

Body​

用于自定义 LLM 等会话行为。若省略,则使用服务端默认值。

字段类型必填说明
avatar_idstring必填要使用的头像 ID
avatar_personaV2StartSessionDto可选人设与 LLM 配置
max_session_durationinteger可选会话最大时长
greeting_textstring可选头像加载时的问候语
在 start 之后,服务端可能会自动朗读问候消息(类型:first_message)

V2StartSessionDto​

名称类型说明必填
languagestring如 en、ko、en-US否
llm_configurationsV2LlmConfigurationsDtoLLM 提供商/模型配置(省略则默认)否

V2LlmConfigurationsDto​

名称类型说明必填
providerstring如 openai、anthropic、google (OpenAI 兼容 SSE/HTTP)否
modelstringLLM 提供商/模型(省略则默认)否
temperaturenumber温度;设置后将转发给 LLM否
custom_settingsV2LlmCustomSettingsDto—否

V2LlmCustomSettingsDto​

名称类型说明必填
greeting_textstring若设置,start 后服务端可能会自动朗读问候否
system_promptstring—否

示例​

curl https://ai-streamer.deepbrain.io/api/v2/sessions/start  \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${SESSION_TOKEN}"
-X POST \
-d '{
"avatar_id": "${YOUR_AVATAR_ID}"
}'

成功(code: 1000)​

{
"code": 1000,
"data": {
"session_id": "${SESSION_ID}",
"max_session_duration": 20,
"max_session_numbers": 10,
"livekit": {
"url": "wss://your-livekit-host",
"room_name": "room-…",
"token": "${LIVEKIT_ACCESS_TOKEN}"
}
},
"message": "会话已开始"
}

下一步​

调用 Start Session 后,使用 livekit.url 与 livekit.token 连接 LiveKit,即可实时流式传输头像的音视频。