获取灵感回复
根据当前用户与指定角色的对话上下文,生成最多 3 条可供用户选择的灵感回复。
每个用户每天前 10 次免费,第 11 次起每次消耗 3 钻石。
请求URL:
/inspirationReply
请求方式:
- POST
认证:
- 需要登录,请在请求头携带
Authorization: Bearer {token}。
请求头:
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| Authorization | 是 | string | 授权 Token,格式:Bearer {token} |
| Content-Type | 是 | string | application/json |
参数:
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| appId | 是 | string | App 唯一标识 |
| udid | 是 | string | 唯一设备 ID |
| roleId | 是 | int | 角色 ID |
| npcId | 否 | uint | NPC 自增 ID;传入时自动按小手机支线聊天处理 |
| branchKey | 否 | string | 对话分支标识;不传时使用用户当前分支 |
| isSmartPhone | 否 | bool | 是否为小手机聊天;主线或支线聊天时传 true,默认 false |
请求示例:
{
"appId": "com.example.app",
"udid": "device-uuid",
"roleId": 3209,
"npcId": 0,
"branchKey": "",
"isSmartPhone": false
}
成功返回示例:
{
"code": 200,
"msg": "SUCCESS",
"data": {
"list": [
"*Steps closer and meets her gaze.* \"Tell me what happened.\"",
"*Lets out a quiet laugh.* \"Are you always this dramatic?\"",
"*Turns toward the door.* \"Come on, let's find out together.\""
],
"maxFreeCount": 10,
"remainingFreeCount": 6
}
}
返回参数说明:
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | int | 状态码,成功时为 200 |
| msg | string | 提示信息 |
| data | object | 灵感回复及免费次数信息;成功、失败都会返回 |
| -list | array<string> | 灵感回复列表;成功时返回 1~3 条非空回复,模型仅生成不足 3 条时也会正常返回,失败时为空数组 |
| -maxFreeCount | int | 每日最大免费次数,当前固定为 10 |
| -remainingFreeCount | int | 当日当前剩余免费次数,最小为 0;本次成功调用已计算在内 |
失败返回示例:
{
"code": 800,
"msg": "param error:Key: 'RoleId' Error:Field validation for 'RoleId' failed on the 'required' tag",
"data": {
"list": [],
"maxFreeCount": 10,
"remainingFreeCount": 6
}
}
{
"code": 510,
"msg": "Network is busy. Please try again later.",
"data": {
"list": [],
"maxFreeCount": 10,
"remainingFreeCount": 6
}
}
错误码:
| 错误码 | 说明 |
|---|---|
| 510 | 系统错误,包括提示词/模型配置获取失败、模型调用失败或模型返回内容解析失败 |
| 660 | 用户账号已被封禁 |
| 670 | 登录状态无效 |
| 730 | 钻石余额不足 |
| 800 | 请求参数错误 |
备注:
- 接口为同步调用,服务端会结合当前角色、场景、分支、NPC、对话记忆及最近一条角色回复生成内容。
- 客户端不需要传入聊天文本;
dialogueCurrent使用当前分支最近一条角色回复。没有历史角色回复时,使用角色开场白。 - 模型可能返回 Markdown 代码块或附带说明文本,服务端会提取其中的 JSON 字符串数组;解析出 1~3 条时均正常返回,超过 3 条时只返回前 3 条。
- 当模型返回内容无法解析出任何有效回复时,服务端会使用相同参数最多兜底重试 10 次;任意一次解析成功即停止重试并正常返回。
- 当
npcId > 0时,即使未传isSmartPhone,服务端也会自动启用小手机聊天上下文。 - 每个用户每天前 10 次成功生成的灵感回复免费;生成失败或返回内容解析失败不计入次数。
- 第 11 次及之后每次消耗 3 钻石。余额不足时返回错误码
730,不会调用模型。 - 付费生成成功并扣费后,服务端会通过 SSE 推送最新余额。
- 无论接口成功或失败,
data都会返回maxFreeCount和remainingFreeCount。如果登录用户或当日次数无法识别,remainingFreeCount返回0。 - 免费次数仅在成功生成灵感回复后减少;生成失败时返回调用前的剩余次数。
- 首次请求及最多 10 次兜底均无法解析出灵感回复时,接口返回
Network is busy. Please try again later.,模型原始返回内容仅记录在服务端日志和后台统计记录中。