AgentList - 查看AI客服列表（支持模糊查询、按条件筛选）
更新时间：2024-11-07
API访问域名
| 请求方式 | GET |
|---|---|
| base url | https://keyue.cloud.baidu.com |
| 后缀接口 | /open/v1/api/v3/agents |
| Authentication | token为API Key |
说明
无
请求参数
Header参数
| 名称 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|
| Content-Type | string | 是 | 内容类型 | 固定值：application/json |
| token | string | 是 | API KEY | 集成-API-API Key处获取。 详细获取方式参考：准备工作 |
| uid | string | 是 | 用户ID | 鼠标移动至页面右上角账户头像即可获取。 详细获取方式参考：准备工作 |
| username | string | 是 | 用户名 | 鼠标移动至页面右上角账户头像即可获取。 详细获取方式参考：准备工作 |
Parameter参数
| 名称 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|
| keyword | string | 否 | AI agent的名称 | 可以根据这个字段模糊查询agent |
| status | string | 否 | agent上线状态，0:未上线，1：发布中，2：已上线 | 可以根据这个字段筛选查询agent |
| pn | integer | 否 | 页数 | 可以根据这个字段分页查询agent，默认是1 |
| ps | integer | 否 | 每页查询数据条数 | 可以根据这个字段分页查询agent，默认是20 |
| orderBy | string | 否 | 排序规则 | 默认按照agent的创建时间排序 |
| order | string | 否 | 排序顺序 | desc降序，asc升序。默认降序 |
| agentScene | integer | 否 | agent场景，0：无场景，1：售前，2：售中，3：售后，4：营销，5：客服 | 可以根据这个字段筛选查询agent |
| type | integer | 否 | agent类型 1：普通agent，2：ai agent | 可以根据这个字段筛选查询agent |
Body参数
无
响应参数
| 名称 | 类型 | 必填 | 中文名 | 说明 |
|---|---|---|---|---|
| time | integer | 是 | 时间 | 1722239381781 |
| data | object | 是 | 数据 | 数据对象 |
| data \ total | integer | 是 | 列表agent总数 | 2 |
| data \ pn | integer | 是 | 页数 | 1 |
| data \ ps | integer | 是 | 每页包含agent数量 | 20 |
| data \ list | object | 是 | 列表数据对象 | |
| data \ list \ id | string | 是 | agent ID | 6536b73c-97b4-4b7b-8d14-1cb9d035354d |
| data \ list \ agentName | string | 是 | agent名称 | QAZgood |
| data \ list \ quickSceneType | integer | 是 | 快捷场景类型，1表示商品导购，2表示线索收集 | null |
| data \ list \ description | string | 是 | agent简介 | test——add |
| data \ list \ avatarUrl | string | 是 | agent图标 | null |
| data \ list \ tenantId | string | 是 | 租户id | 34363705908000000 |
| data \ list \ updated | string | 是 | 更新时间 | 2024-07-29 15:49:41 |
| data \ list \ created | string | 是 | 创建时间 | 2024-07-29 15:49:41 |
| data \ list \ createdUserId | string | 是 | 创建用户uid | dd6283a283df42998bab14607e23f38d |
| data \ list \ createdUsername | string | 是 | 创建用户名 | xxxxxxxx |
| data \ list \ lastEditId | string | 是 | 最后修改人uid | null |
| data \ list \ lastEditUsername | string | 是 | 最后修改人用户名 | null |
| data \ list \ published | string | 是 | 发布时间 | 1970-01-01 00:00:00 |
| data \ list \ status | string | 是 | agent上线状态，0:未上线，1：发布中，2：已上线 | null |
| data \ list \ agentStatus | string | 是 | agent编辑状态，0.可编辑，1.不可编辑 | null |
| data \ list \ agentDelete | string | 是 | agent删除状态，0.可用, 1.删除 | null |
| data \ list \ dataSetId | string | 是 | 数据集，每个agent对应一个dateSetSId | "1" |
| data \ list \ token | string | 是 | 开放接口：API Key | null |
| data \ list \ type | integer | 是 | agent类型 1：普通agent，2：ai agent | 1 |
| data \ list \ agentLabel | string | 是 | agent标签 | null |
| data \ list \ agentScene | integer | 是 | agent场景，0：无场景，1：售前，2：售中，3：售后，4：营销，5：客服 | 0 |
| data \ list \ multiQuery | string | 是 | 租户使用版本是否为标准版 | null |
| data \ list \ refresh | string | 是 | 判断是否有正在运行的agent任务，如果有则为true，否则为false | |
| code | integer | 是 | 状态码 | 200 |
| msg | string | 是 | 状态信息 | OK |
请求示例
curl --location 'http://keyue-test.cloud.baidu.com/open/v1/api/v3/agents?keyword=' \
--header 'token: 7f3894e7-01d8-4e2e-88d0-ef437ffd3f63' \
--header 'uid: dd6283a283df42998bab14607e23f38d' \
--header 'username: xxxxxxxx' \
--header 'Content-Type: application/json'响应示例
{
"time": 1722249505976,
"data": {
"total": 2,
"pn": 1,
"ps": 20,
"list": [
{
"id": "6536b73c-97b4-4b7b-8d14-1cb9d035354d",
"agentName": "QAZgood",
"quickSceneType": 0,
"description": "test——add",
"avatarUrl": "",
"tenantId": "34363705908000000",
"updated": "2024-07-29 15:49:41",
"created": "2024-07-29 15:49:41",
"createdUserId": "dd6283a283df42998bab14607e23f38d",
"createdUsername": "xxxxxxxx",
"lastEditId": null,
"lastEditUsername": null,
"published": "1970-01-01 00:00:00",
"status": 0,
"agentStatus": 0,
"agentDelete": 0,
"dataSetId": "1",
"token": null,
"type": 1,
"agentLabel": "",
"agentScene": 0,
"multiQuery": false
},
{
"id": "ae8b75e0-2e75-446a-b291-c6995c94c9e3",
"agentName": "Agent示例-旅游助手",
"quickSceneType": 0,
"description": "",
"avatarUrl": "",
"tenantId": "34363705908000000",
"updated": "2024-06-27 15:32:39",
"created": "2024-06-12 17:37:23",
"createdUserId": "system",
"createdUsername": "system",
"lastEditId": "system",
"lastEditUsername": "system",
"published": "1970-01-01 00:00:00",
"status": 0,
"agentStatus": 0,
"agentDelete": 0,
"dataSetId": "1",
"token": null,
"type": 1,
"agentLabel": "",
"agentScene": 0,
"multiQuery": false
}
],
"refresh": false
},
"code": 200,
"msg": "OK"
}