基础信息
| 请求方式 | 请求地址 |
| GET | https://api.helpbots.ai/api/chats/agent-list |
请求参数
Header
| 参数名 |
取值
|
说明 |
|---|---|---|
| x-api-key | $apikey |
用于验证客户端身份的访问令牌。你可以在后台生成访问令牌，详细信息，参考获取api key |
Query params
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| page | int | 否 |
分页查询时的页码 默认为1 |
| pagesize | int | 否 |
分页大小 默认为20 |
返回参数
List
| 参数名 | 类型 | 说明 |
|---|---|---|
| id | string | 项目apikey下的智能体ID |
| name | string | 智能体对应名称 |
| desc | string | 智能体描述 |
| icon | string | 智能体图标地址 |
| prompt | string | 提示词 |
| unknown_text | string | 未匹配答案回复 |
| with_resources | string | 关联的知识库 |
| show_source | string | 展示知识库来源 0-否 1-是 |
| publish_status | string |
智能体发布状态 0-未发布过 1-已发布过 |
| model | string |
问答模型 |
| api_switch | string |
集成API状态 0-关闭 1-开启 |
| sdk_switch | string |
集成SDK状态 0-关闭 1-开启 |
| add_time | string |
创建时间 |
示例
请求示例
curl --location --request GET 'https://api.helpbots.ai/api/chats/agent-list?page=1&pagesize=20' \
--header 'x-api-key: yourapikey' \响应示例
{
"data": {
"list": [
{
"id": "1*****",
"name": "testttt",
"desc": "testttt",
"icon": "https://resource-******/development/project/{project_id}/ai_agent_icon/680********",
"prompt": "",
"unknown_text": "",
"with_resources": "",
"show_source": "0",
"publish_status": "1",
"model": "deepseek-v3",
"api_switch": "1",
"sdk_switch": "1",
"add_time": "1745230471"
},
{
"id": "1*****",
"name": "tes2",
"desc": "tes2",
"icon": "https://resource-******/development/project/{project_id}/ai_agent_icon/680********",
"prompt": "",
"unknown_text": "",
"with_resources": "",
"show_source": "0",
"publish_status": "1",
"model": "deepseek-v3",
"api_switch": "1",
"sdk_switch": "1",
"add_time": "1745230471"
},
{
"id": "1*****",
"name": "tes3",
"desc": "tes3",
"icon": "https://resource-******/development/project/{project_id}/ai_agent_icon/680********",
"prompt": "",
"unknown_text": "",
"with_resources": "",
"show_source": "0",
"publish_status": "1",
"model": "deepseek-v3",
"api_switch": "1",
"sdk_switch": "1",
"add_time": "1745230471"
}
],
"total": 3,
"page": 1,
"page_size": 20
},
"msg": "Success",
"code": 200
}