乐享知识库接口文档 停止指定会话中正在生成中的 AI 回答。
请求URL
POST https://lxapi.lexiangla.com/cgi-bin/v2/ai/qa/cancel
请求头
| 参数 | 是否必须 | 说明 |
|---|---|---|
| Content-Type | 是 | 固定值:"application/json; charset=utf-8" |
| Authorization | 是 | 接口调用凭证 access_token 值格式:"Bearer access_token" 示例值:"Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJS" |
| x-staff-id | 是 | 发起问答的成员帐号,必须与发起问答时使用的 x-staff-id 相同 |
其他说明
| 事项 | 说明 |
|---|---|
| 权限要求 | AI 助手 |
请求参数
{
"threadId": "84764a80099c4431819f3f09a864bee8",
"runId": "16bd2428226a4b1f9124728a7b1aeab7"
}
参数说明
| 参数 | 是否必须 | 默认值 | 说明 |
|---|---|---|---|
| threadId | 是 | 无 | 会话ID。Agent 模式(/v2/ai/qa)为响应中的 threadId(非流式响应为 session_id 字段);AI 问答(/v1/ai/qa)为流式消息中的 session_id 字段 |
| runId | 是 | 无 | 轮次ID,标识要停止的那一轮回答。Agent 模式为响应中的 runId(非流式响应为 completion_id 字段);AI 问答为流式消息中的 completion_id 字段 |
行为说明
finish_reason 为 user canceled(正常完成为 stop),可用于区分用户主动中断与链路异常响应
200 OK 状态码
{
"code": 0,
"message": "success",
"request_id": "eb83bd93-5e50-4a0a-8db6-c0fb1bc7aa2b",
"data": null
}
错误响应
{
"code": 51,
"message": "解析请求体失败:...",
"request_id": "eb83bd93-5e50-4a0a-8db6-c0fb1bc7aa2b",
"data": null
}
错误码说明
| HTTP状态码 | code | 说明 |
|---|---|---|
| 400 | 51 | 请求参数校验失败(threadId、runId 必填) |
| 401 | 41 | AccessToken 无效或鉴权失败 |
| 500 | 999 | 服务内部错误,请携带 request_id 联系管理员排查 |