You need to enable JavaScript to run this app.
文档中心
数据智能体 DataAgent(私有化)

数据智能体 DataAgent(私有化)

复制全文
下载 pdf
智能体
读取智能体列表
复制全文
下载 pdf
读取智能体列表

读取智能体列表 getAgentList

请求说明

用于获取当前租户下可用的智能体列表,支持按关键字搜索与分页。

项目

内容

请求方式

GET

请求地址

https://${IDA_DOMAIN}/dataAgent/llm/openApi/v2/signed/agent/getAgentList?page=1&pageSize=10

默认鉴权

Authorization: Bearer ${JWT_TOKEN}

内容类型

Content-Type: application/json

请求参数

参数通过 QueryString 传递。

位置

参数

类型

是否必选

示例值

说明

Query

kw

string

否

风神

查询关键字,用于按名称等字段模糊匹配。

Query

page

number

否

1

页码。1 表示第一页,默认 1。

Query

pageSize

number

否

10

每页条数。默认 16。

请求示例

带分页参数:

curl -X GET \
  "https://${IDA_DOMAIN}/dataAgent/llm/openApi/v2/signed/agent/getAgentList?page=1&pageSize=1" \
  -H "Authorization: Bearer ${JWT_TOKEN}" \
  -H "Content-Type: application/json" \
  --silent | jq

不传分页参数(使用默认值):

curl -X GET \
  "https://${IDA_DOMAIN}/dataAgent/llm/openApi/v2/signed/agent/getAgentList" \
  -H "Authorization: Bearer ${JWT_TOKEN}" \
  -H "Content-Type: application/json" \
  --silent | jq

返回参数

字段路径

类型

示例值

说明

JSONIFY_PRETTYPRINT_REGULAR

boolean

false

JSON 输出配置标记(服务端内部字段)。

code

string

llm/ok

请求结果码。示例表示请求成功。

msg

object

{}

提示信息对象,可能为空。

data

object

Agent 列表分页结果。

data 字段

字段路径

类型

示例值

说明

data.list

array

当前页的 Agent 列表。

data.total

integer

229

符合查询条件的 Agent 总数。

data.list[] 字段(Agent 对象)

字段路径

类型

示例值

说明

data.list[]

object

单个 Agent 对象。

data.list[].id

integer

298

Agent ID。

data.list[].name

string

Data Agent

Agent 名称。

data.list[].pcName

string

Data Agent

PC 端展示名称。

data.list[].description

string

AI驱动的数据分析新方式,让数据主动说话、自动协作。

Agent 描述。

data.list[].pcDescription

string

AI驱动的数据分析新方式,让数据主动说话、自动协作。

PC 端展示描述。

data.list[].avatar

string

systemGeneral

Agent 头像标识(或头像 URL,取决于实际返回)。

data.list[].pcAvatar

string

systemGeneral

PC 端头像标识(或头像 URL,取决于实际返回)。

data.list[].agentType

string

General

Agent 类型。示例为通用 Agent。

data.list[].agentMode

string

knowledgeQA

Agent 默认/当前模式。

data.list[].status

integer

1

Agent 状态。示例中 1 通常表示可用(以实际枚举为准)。

data.list[].creatorPrefix

string

admin

创建人账号前缀(如邮箱前缀)。

data.list[].creatorName

string

管理员

创建人展示名称。

data.list[].creatorAvatar

string

null

null

data.list[].isAdmin

boolean

true

当前用户是否为该 Agent 管理员。

data.list[].isPersonal

boolean

false

是否为个人 Agent。

data.list[].ctime

string

2026-08-06 11:49:49

创建时间。

data.list[].mtime

string

2026-08-11 22:04:57

更新时间。

data.list[].config

object

Agent 配置(字段较多,以实际返回为准)。

data.list[].analysisParams

boolean

true

是否开启分析参数能力。

data.list[].simpleAnalyzeSw

boolean

true

是否开启简单分析开关。

data.list[].concurrentMultiRoundSw

boolean

false

是否开启并发多轮开关。

data.list[].config 字段

字段路径

类型

示例值

说明

data.list[].config.isInsightReportOpen

boolean

false

是否开启洞察报告配置。

data.list[].config.isNewAgent

boolean

false

是否为新版 Agent。

分页说明(与请求参数对应)

字段

示例值

说明

page

1

请求页码(来自请求参数 page)。

pageSize

1

每页大小(来自请求参数 pageSize)。

data.list.length

1

当前页实际返回条数。

data.total

229

满足条件的总条数。

响应示例

{
  "JSONIFY_PRETTYPRINT_REGULAR": false,
  "code": "llm/ok",
  "data": {
    "list": [
      {
        "agentMode": "knowledgeQA",
        "agentType": "General",
        "analysisParams": true,
        "avatar": "systemGeneral",
        "concurrentMultiRoundSw": false,
        "config": {
          "isInsightReportOpen": false,
          "isNewAgent": false
        },
        "creatorAvatar": null,
        "creatorName": "管理员",
        "creatorPrefix": "admin",
        "ctime": "2026-08-06 11:49:49",
        "description": "AI驱动的数据分析新方式,让数据主动说话、自动协作。",
        "id": 298,
        "isAdmin": true,
        "isPersonal": false,
        "mtime": "2026-08-11 22:04:57",
        "name": "Data Agent",
        "pcAvatar": "systemGeneral",
        "pcDescription": "AI驱动的数据分析新方式,让数据主动说话、自动协作。",
        "pcName": "Data Agent",
        "simpleAnalyzeSw": true,
        "status": 1
      }
    ],
    "total": 229
  },
  "msg": {}
}

最近更新时间:2026.08.17 14:12:00
这个页面对您有帮助吗?
有用
有用
无用
无用