查询 Agent 列表信息

GET 
/v1/aibot/bots

查询 Agent 列表信息

Request

Query Parameters

name string
Agent 名称 模糊查询
Example: 名称
introduction string
Agent 简介 模糊查询
Example: 简介
information string
Agent 信息模糊查询 查询名称和简介
Example: 信息
enable boolean
Agent 是否启用
Example: true
pageSize number
分页查询参数，默认为 10
Example: 10
pageNumber number
分页查询参数，默认为 1
Example: 1

Responses

200

查询 AI Agent 成功时返回

Response Headers

• X-Request-Id string

  请求ID

application/json

Schema

Schema

botList object[]required
Agent 列表
Array [
botId string
Agent ID，由系统生成
name stringrequired
Agent 名称
introduction stringrequired
Agent 简介
welcomeMessage string
Agent 欢迎语
avatar string
Agent 头像链接
background string
Agent 聊天背景图链接
isNeedRecommend boolean
Agent 回答后是否推荐问题
type string
Agent 类型, text 或者 image
searchEnable boolean
是否开启联网搜索
]
total numberrequired

Agent 总数

Example (from schema)

{
  "botList": [
    {
      "botId": "bot-xxx",
      "name": "智能体",
      "introduction": "简介",
      "welcomeMessage": "欢迎欢迎",
      "avatar": "http://xxx.avatar.image",
      "background": "http://xxx.background.image",
      "isNeedRecommend": false,
      "type": "text",
      "searchEnable": false
    }
  ],
  "total": 10
}

default

查询 AI Agent 失败时返回

application/json

Schema

Schema

code string

错误代码

message string

错误信息

requestId string

请求ID

Example (from schema)

{
  "code": "INVALID_CREDENTIALS",
  "message": "Credentials are invalid",
  "requestId": "6360ba4b-f672-434b-9dee-35686a5589a4"
}

Loading...