停止对话式智能体
更新时间不可用
停止指定的对话式智能体实例,并让智能体退出 RTC 频道。
POST
https://api.agora.io/cn/api/conversational-ai-agent/v2/projects/{appid}/agents/{agentId}/leaveappidstring必填
你的项目使用的 App ID。
agentIdstring必填
智能体实例 ID,即智能体的唯一标识。调用 POST 创建对话式智能体 成功后在响应包体中获取。
Authorizationstring必填
发送 HTTP 请求时,你可以从以下鉴权方式中任选其一:
- 使用 Token 认证(推荐):参考实现 HTTP 鉴权生成 Token 并填入
AuthorizationHeader。传参示例:Authorization: agora token="007abcxxxxxxx123"。 - 使用 Basic Auth:参考实现 HTTP 鉴权生成 Base64 编码的
Authorization字段。传参示例:Authorization: Basic NDI1OTQ3N2I4MzYy...YwZjA=。
响应
- 若返回的状态码为
200则表示请求成功。响应包体为空。 - 若返回的状态码不为
200则表示请求失败。响应包体中包含错误的类别和描述,你可以参考响应状态码了解可能的原因。
请求示例
curl --request POST \
--url "https://api.agora.io/cn/api/conversational-ai-agent/v2/projects/:appid/agents/:agentId/leave" \
--header 'Authorization: agora token="007abcxxxxxxx123"'响应示例
- 若返回的状态码为
200则表示请求成功。响应包体为空。 - 若返回的状态码不为
200则表示请求失败。响应包体中包含错误的类别和描述,你可以参考响应状态码了解可能的原因。