AgentDetail - 查看AI客服详情
更新时间：2024-11-07
API访问域名
| 请求方式 | GET |
|---|---|
| base url | https://keyue.cloud.baidu.com |
| 后缀接口 | /open/v1/api/v3/agents/detail |
| Authentication | token为API Key |
说明
无
请求参数
Header参数
| 名称 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|
| Content-Type | string | 是 | 内容类型 | 固定值：application/json |
| token | string | 是 | API KEY | 集成-API-API Key处获取。 详细获取方式参考：准备工作 |
| uid | string | 是 | 用户ID | 鼠标移动至页面右上角账户头像即可获取。 详细获取方式参考：准备工作 |
| username | string | 是 | 用户名 | 鼠标移动至页面右上角账户头像即可获取。 详细获取方式参考：准备工作 |
Body参数
| 名称 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|
| id | string | 是 | AI agent的ID |
响应参数
| 名称 | 类型 | 必填 | 中文名 | 说明 |
|---|---|---|---|---|
| time | integer | 是 | 时间 | 1722251938059 |
| data | object | 是 | 数据 | 数据对象 |
| data \ id | string | 是 | agent ID | 1b0a986f-6d50-4f26-8b80-79568d775304 |
| data \ agentName | string | 是 | agent名称 | test |
| data \ quickSceneType | integer | 是 | 快捷场景类型，1表示商品导购，2表示线索收集 | |
| data \ description | string | 是 | agent简介 | null |
| data \ avatarUrl | string | 是 | agent图标 | |
| data \ tenantId | string | 是 | 租户id | 3156952326602753 |
| data \ updated | string | 是 | 更新时间 | 2024-07-29 17:29:08 |
| data \ created | string | 是 | 创建时间 | 2024-01-17 10:28:01 |
| data \ createdUserId | string | 是 | 创建用户uid | 93d54a5ff6ef47579e0b4d0aea811c9d |
| data \ createdUsername | string | 是 | 创建用户名 | pnstest3 |
| data \ lastEditId | string | 是 | 最后修改人uid | 93d54a5ff6ef47579e0b4d0aea811c9d |
| data \ lastEditUsername | string | 是 | 最后修改人用户名 | pnstest3 |
| data \ published | string | 是 | 发布时间 | 2024-07-29 17:29:08 |
| data \ status | string | 是 | agent上线状态，0:未上线，1：发布中，2：已上线 | 2 |
| data \ agentStatus | string | 是 | agent编辑状态，0.可编辑，1.不可编辑 | 0 |
| data \ agentDelete | string | 是 | agent删除状态，0.可用, 1.删除 | 0 |
| data \ dataSetId | string | 是 | 数据集，每个agent对应一个dateSetSId | "1" |
| data \ token | string | 是 | 开放接口：API Key | 71f2d8b2-6121-45b8-a704-2ab7dca912c1 |
| data \ type | integer | 是 | agent类型 1：普通agent，2：ai agent | 1 |
| data \ agentLabel | string | 是 | agent标签 | null |
| data \ agentScene | integer | 是 | agent场景，0：无场景，1：售前，2：售中，3：售后，4：营销，5：客服 | 0 |
| data \ multiQuery | string | 是 | 租户使用版本是否为标准版 | true |
| code | integer | 是 | 状态码 | 200 |
| msg | string | 是 | 状态信息 | OK |
请求示例
curl --location 'http://keyue-test.cloud.baidu.com/open/v1/api/v3/agents/detail?id=1b0a986f-6d50-4f26-8b80-79568d775304' \
--header 'token: 7f3894e7-01d8-4e2e-88d0-ef437ffd3f63' \
--header 'uid: dd6283a283df42998bab14607e23f38d' \
--header 'username: xxxxxxxx' \
--header 'Content-Type: application/json'响应示例
{
"time": 1722251938059,
"data": {
"id": "1b0a986f-6d50-4f26-8b80-79568d775304",
"agentName": "test",
"quickSceneType": 0,
"description": null,
"avatarUrl": "",
"tenantId": "3156952326602753",
"updated": "2024-07-29 17:29:08",
"created": "2024-01-17 10:28:01",
"createdUserId": "93d54a5ff6ef47579e0b4d0aea811c9d",
"createdUsername": "pnstest3",
"lastEditId": "93d54a5ff6ef47579e0b4d0aea811c9d",
"lastEditUsername": "pnstest3",
"published": "2024-07-29 17:29:08",
"status": 2,
"agentStatus": 0,
"agentDelete": 0,
"dataSetId": "1",
"token": "71f2d8b2-6121-45b8-a704-2ab7dca912c3",
"type": 1,
"agentLabel": null,
"agentScene": 0,
"multiQuery": true
},
"code": 200,
"msg": "OK"
}{
"time": 1722251712811,
"data": null,
"code": 200,
"msg": "OK"
}