读取 Agent 详情
接口说明
请求说明
该 API 用于通过指定的 Agent 名称来获取其详细的配置信息,包括但不限于模型配置、系统提示词、工具列表等。请求时需要提供准确的 Agent 名称作为参数。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
dataworks:GetAgent |
get |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| Name |
string |
是 |
要读取的 Skill 名称。 |
my-skill |
| AgentVersion |
integer |
否 |
省略时读取当前定义;指定已发布版本时读取对应快照及固定的官方 Skill、套件制品版本;指定当前未发布版本时仍返回草稿,不返回固定制品版本。不是 POP 系统参数 Version。 |
2 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
返回参数 |
||
| Agent |
object |
创建的 Agent 详情 |
|
| AgentVersion |
integer |
本次读取的定义版本。更新当前定义时,将该值作为 UpdateAgent 的 ExpectedVersion,可拒绝覆盖其他调用者已提交的新版本。读取历史快照的版本不代表当前版本。 |
2 |
| CallableAgents |
array<object> |
可调用的子 Agent 列表。 |
|
|
object |
|||
| DisplayName |
string |
子 Agent 展示名称。 |
子助手 |
| Name |
string |
子 Agent 名称。 |
sub-agent |
| Source |
string |
子 Agent 来源。 |
custom |
| Version |
integer |
子 Agent 版本号。 |
- |
| CreatorId |
string |
创建者 ID。 |
123456 |
| Description |
string |
描述。 |
数据分析助手 |
| DisplayName |
string |
展示名称。 |
我的助手 |
| ExpertSuites |
array<object> |
Agent 定义绑定的专家套件,包含固定整数修订号或版本选择策略;官方资源继续使用 PackageVersion 表示制品版本。 |
|
|
object |
|||
| Description |
string |
套件已删除、发布快照缺失或调用者无权查看时,不返回套件摘要,仅保留 ID 和版本号。 |
数据分析专家能力集合 |
| DisplayName |
string |
绑定版本的展示名称 |
数据分析专家套件 |
| Name |
string |
绑定版本的套件名称 |
analysis-suite |
| PackageVersion |
string |
显式查询 Agent 已发布版本时返回固定的官方制品版本;查询草稿或自定义套件时不返回。 |
0.1.0.202610211408 |
| SemanticVersion |
string |
可选套件摘要字段,当前新 DataAgent 应用不返回;缺省不表示版本 0。不可作为 UpdateAgent 的 Version,回写引用时必须省略。官方制品的固定版本请读取 PackageVersion。 |
1.2.0 |
| Source |
string |
OFFICIAL 表示官方目录资源;省略或 DB 表示个人或企业资源。 |
OFFICIAL |
| SuiteId |
string |
专家套件 ID |
suite_example |
| Version |
integer |
仅个人或企业套件在引用明确指定固定整数版本时返回;官方套件不返回。未返回不是 0;SDK 若将缺省整数初始化为 0,回写时必须省略。官方项只回写 Source 和 SuiteId,不传 Version、VersionSelector、SemanticVersion 或 PackageVersion。 |
3 |
| VersionSelector |
string |
仅个人或企业资源返回已保存的版本选择策略,与固定整数 Version 互斥;不代表会话实际加载的具体修订。官方资源不返回。 |
^1.2.3 |
| GmtCreateTime |
integer |
创建时间(毫秒时间戳)。 |
1780555634000 |
| GmtModifiedTime |
integer |
最近修改时间(毫秒时间戳)。 |
1780555634000 |
| Metadata |
object |
扩展元数据。 |
{} |
| Model |
object |
模型配置。 |
|
| Config |
object |
模型的额外配置。 |
{} |
| MaxTokens |
integer |
单次最大输出 Token 数。 |
8192 |
| ModelName |
string |
模型名称。 |
qwen3-max |
| Stream |
boolean |
是否流式输出。 |
true |
| Temperature |
number |
采样温度。 |
1 |
| TopP |
number |
核采样 Top-P。 |
1 |
| ModifierId |
string |
最近修改者 ID。 |
123456 |
| Name |
string |
Agent 名称。 |
my-agent |
| RequiredRuntime |
array |
运行所需的环境依赖。 |
|
|
string |
空 |
- |
|
| Skills |
array<object> |
技能列表。 |
|
|
object |
Agent 关联的 Skill 详情。 |
||
| Name |
string |
技能名称。 |
my-skill |
| PackageVersion |
string |
指定 AgentVersion 查询已发布快照时返回固定的官方制品版本;查询草稿或自定义 Skill 时不返回。 |
0.6.0.202608201110 |
| SkillId |
string |
官方 Skill ID |
dataworks-semantic |
| Source |
string |
OFFICIAL 表示官方目录资源;省略或 DB 表示原有个人或企业资源。 |
OFFICIAL |
| Version |
integer |
技能版本号。 |
- |
| VersionSelector |
string |
仅个人或企业资源返回已保存的版本选择策略,与固定整数 Version 互斥;不代表会话实际加载的具体修订。官方资源不返回。 |
^1.2.3 |
| SystemPrompt |
string |
系统提示词。 |
你是一个数据分析助手。 |
| Tools |
array<object> |
工具列表。 |
|
|
object |
|||
| BuiltinName |
string |
内置工具名称,Kind 为 |
builtin_sql |
| Kind |
string |
工具类型。 |
builtin |
| McpItems |
array |
选用的 MCP 工具项,Kind 为 |
|
|
string |
工具名称,默认为全部 |
search_table |
|
| McpServerName |
string |
关联的 MCP Server 名称,Kind 为 |
server-name |
| Visibility |
string |
可见性级别。 |
TENANT |
| VisibilityScope |
object |
可见性范围。 |
|
| ProjectIds |
array |
可见的项目 ID 列表。 |
|
|
string |
项目 id 列表 |
proj_001 |
|
| UserIds |
array |
可见的用户 ID 列表。 |
|
|
string |
用户 ID |
123456 |
|
| RequestId |
string |
请求 ID。 |
824F80BA-1778-5D8A-BAFF-668A4D9C4CC7 |
示例
正常返回示例
JSON格式
{
"Agent": {
"AgentVersion": 2,
"CallableAgents": [
{
"DisplayName": "子助手",
"Name": "sub-agent",
"Source": "custom",
"Version": 0
}
],
"CreatorId": "123456",
"Description": "数据分析助手",
"DisplayName": "我的助手",
"ExpertSuites": [
{
"Description": "数据分析专家能力集合",
"DisplayName": "数据分析专家套件",
"Name": "analysis-suite",
"PackageVersion": "0.1.0.202610211408",
"SemanticVersion": "1.2.0",
"Source": "OFFICIAL",
"SuiteId": "suite_example",
"Version": 3,
"VersionSelector": "^1.2.3"
}
],
"GmtCreateTime": 1780555634000,
"GmtModifiedTime": 1780555634000,
"Metadata": {},
"Model": {
"Config": {},
"MaxTokens": 8192,
"ModelName": "qwen3-max",
"Stream": true,
"Temperature": 1,
"TopP": 1
},
"ModifierId": "123456",
"Name": "my-agent",
"RequiredRuntime": [
"-"
],
"Skills": [
{
"Name": "my-skill",
"PackageVersion": "0.6.0.202608201110",
"SkillId": "dataworks-semantic",
"Source": "OFFICIAL",
"Version": 0,
"VersionSelector": "^1.2.3"
}
],
"SystemPrompt": "你是一个数据分析助手。",
"Tools": [
{
"BuiltinName": "builtin_sql",
"Kind": "builtin",
"McpItems": [
"search_table"
],
"McpServerName": "server-name"
}
],
"Visibility": "TENANT",
"VisibilityScope": {
"ProjectIds": [
"proj_001"
],
"UserIds": [
"123456"
]
}
},
"RequestId": "824F80BA-1778-5D8A-BAFF-668A4D9C4CC7"
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。