服务端 API 接口文档
文档中心/LG 开放平台

LG 开放平台接口文档

更新时间:2026/08/18

服务地址

LG 开放平台服务,接口路径均以服务前缀拼接:

服务基地址用途
LG 开放平台https://lg.jimitu.top角色/会话/消息/渠道/TTS(默认)
注意

完整请求地址 = 服务前缀 + 接口路径,例如:https://lg.jimitu.top/api/open/publishings

接口调用一览表

#方法路径说明
1GET/api/open/publishings获取上架列表详情 →
2GET/api/open/channels获取硬件渠道列表详情 →
3GET/api/open/publishings/{id}获取单个上架详情详情 →
4POST/api/open/channels/{channel_id}/bind-device绑定设备到渠道详情 →
5DELETE/api/open/channels/{channel_id}/bind-device解绑设备详情 →
6GET/api/open/devices/character查询设备绑定的有效角色详情 →
7GET/api/open/devices/status查询设备实时状态详情 →
8GET/api/open/characters/{id}获取角色实例详情详情 →
9PUT/api/open/characters/{id}更新角色实例属性详情 →
10DELETE/api/open/characters/{id}删除角色实例详情 →
11GET/api/open/sessions获取会话列表详情 →
12GET/api/open/sessions/{session_id}/messages分页获取会话历史消息详情 →
13DELETE/api/open/sessions/{session_id}删除会话及其全部消息详情 →
14DELETE/api/open/sessions/{session_id}/messages删除会话中的消息详情 →
15POST/api/open/sessions/{session_id}/messages/import批量导入历史消息详情 →
16POST/api/open/characters/{id}/tts流式语音合成详情 →

合计:16 个接口,每个接口独立一页,详见左侧目录或下方分组。

统一请求约定

3.1 请求头

接口鉴权通过请求头 Authorization 携带 API Key。所有接口涉及的请求头如下:

Header必填说明
AuthorizationBearer {API Key},接口鉴权,所有请求均需携带
Content-Type仅 POST/PUT 携带 JSON 请求体时需要,值为 application/json

请求示例(curl):

# 查询上架列表
curl -X GET "https://lg.jimitu.top/api/open/publishings" \
  -H "Authorization: Bearer <your_api_key>"
注意

<your_api_key> 为 API Key(调用方申请);设备相关接口的设备 ID 通过请求参数(device_id)传递,用户身份通过请求参数(external_user_id / user_id)传递,详见各接口定义。

3.2 设备绑定流程(channel_id 说明)

绑定设备时,渠道 ID(channel_id)由平台根据设备码自动匹配,调用方无需手动指定或预先查询。完整流程分两步:

  1. 设备 → 渠道:提交设备码后,平台通过 GET /api/open/devices/character?device_id=<设备码> 反查该设备归属的渠道,得到 channel_id
  2. 发起绑定:用查到的 channel_id 调用 POST /api/open/channels/{channel_id}/bind-device 完成绑定

说明:

3.3 统一响应格式

标准 ApiResponse<T>

{
  "success": true,
  "data": T,
  "message": "(失败时)错误说明",
  "error_code": "(失败时)错误码",
  "pagination": { /* 分页响应时附带 */ }
}

分页响应(保留完整对象,含 pagination):

{
  "data": [ ... ],
  "pagination": {
    "current_page": 1,
    "total_pages": 3,
    "total_count": 58,
    "has_next": true,
    "has_previous": false
  }
}

响应解包规则:

3.4 错误处理

所有接口的错误响应遵循统一格式:{ "success": false, "message": "...", "error_code": "..." }

HTTP 状态含义
401API Key 无效或已过期
403无权限访问该资源
400请求参数错误
404资源不存在(业务级,含 error_code 字段)
409设备 ID 需消歧、角色未绑定或外部用户 ID 已被占用(设备接口)
500服务器内部错误

error_code 枚举(通用):

error_code说明
CHARACTER_NOT_FOUND角色不存在
SESSION_NOT_FOUND会话不存在
TEMPLATE_NOT_FOUND模版不存在
PUBLISHING_NOT_FOUND上架不存在或无权访问
INVALID_QUERY_PARAMETER查询参数格式错误或超分页上限
注意

路由级 404(接口路径不存在)不包含 successerror_code 字段,可据此区分。

注意

普通请求超时 30s;SSE/音频流接口为长连接,超时 300s。