根据名称读取单个 Agent 的详细信息。
接口说明
请求说明
该 API 用于通过指定的 Agent 名称来获取其详细的配置信息,包括但不限于模型配置、系统提示词、工具列表等。请求时需要提供准确的 Agent 名称作为参数。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| Name |
string |
是 |
要读取的 Skill 名称。 |
my-skill |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
返回参数 |
||
| RequestId |
string |
请求 ID。 |
824F80BA-1778-5D8A-BAFF-668A4D9C4CC7 |
| Agent |
object |
创建的 Agent 详情 |
|
| CreatorId |
string |
创建者 ID。 |
123456 |
| ModifierId |
string |
最近修改者 ID。 |
123456 |
| Name |
string |
Agent 名称。 |
my-agent |
| DisplayName |
string |
展示名称。 |
我的助手 |
| Description |
string |
描述。 |
数据分析助手 |
| Model |
object |
模型配置。 |
|
| ModelName |
string |
模型名称。 |
qwen3-max |
| Temperature |
number |
采样温度。 |
1 |
| TopP |
number |
核采样 Top-P。 |
1 |
| MaxTokens |
integer |
单次最大输出 Token 数。 |
8192 |
| Stream |
boolean |
是否流式输出。 |
true |
| Config |
object |
模型的额外配置。 |
{} |
| SystemPrompt |
string |
系统提示词。 |
你是一个数据分析助手。 |
| Tools |
array<object> |
工具列表。 |
|
|
object |
|||
| Kind |
string |
工具类型。 |
builtin |
| BuiltinName |
string |
内置工具名称,Kind 为 |
builtin_sql |
| McpServerName |
string |
关联的 MCP Server 名称,Kind 为 |
server-name |
| McpItems |
array |
选用的 MCP 工具项,Kind 为 |
|
|
string |
工具名称,默认为全部 |
search_table |
|
| Skills |
array<object> |
技能列表。 |
|
|
object |
|
||
| Name |
string |
技能名称。 |
my-skill |
| Version |
integer |
技能版本号。 |
- |
| CallableAgents |
array<object> |
可调用的子 Agent 列表。 |
|
|
object |
|||
| Name |
string |
子 Agent 名称。 |
sub-agent |
| DisplayName |
string |
子 Agent 展示名称。 |
子助手 |
| Version |
integer |
子 Agent 版本号。 |
- |
| Source |
string |
子 Agent 来源。 |
custom |
| RequiredRuntime |
array |
运行所需的环境依赖。 |
|
|
string |
空 |
- |
|
| Metadata |
object |
扩展元数据。 |
{} |
| Visibility |
string |
可见性级别。 |
TENANT |
| VisibilityScope |
object |
可见性范围。 |
|
| ProjectIds |
array |
可见的项目 ID 列表。 |
|
|
string |
项目 id 列表 |
proj_001 |
|
| UserIds |
array |
可见的用户 ID 列表。 |
|
|
string |
用户 ID |
123456 |
|
| GmtCreateTime |
string |
创建时间(毫秒时间戳)。 |
1780555634000 |
| GmtModifiedTime |
string |
最近修改时间(毫秒时间戳)。 |
1780555634000 |
示例
正常返回示例
JSON格式
{
"RequestId": "824F80BA-1778-5D8A-BAFF-668A4D9C4CC7",
"Agent": {
"CreatorId": "123456",
"ModifierId": "123456",
"Name": "my-agent",
"DisplayName": "我的助手",
"Description": "数据分析助手",
"Model": {
"ModelName": "qwen3-max",
"Temperature": 1,
"TopP": 1,
"MaxTokens": 8192,
"Stream": true,
"Config": {}
},
"SystemPrompt": "你是一个数据分析助手。",
"Tools": [
{
"Kind": "builtin",
"BuiltinName": "builtin_sql",
"McpServerName": "server-name",
"McpItems": [
"search_table"
]
}
],
"Skills": [
{
"Name": "my-skill",
"Version": 0
}
],
"CallableAgents": [
{
"Name": "sub-agent",
"DisplayName": "子助手",
"Version": 0,
"Source": "custom"
}
],
"RequiredRuntime": [
"-"
],
"Metadata": {},
"Visibility": "TENANT",
"VisibilityScope": {
"ProjectIds": [
"proj_001"
],
"UserIds": [
"123456"
]
},
"GmtCreateTime": "1780555634000",
"GmtModifiedTime": "1780555634000"
}
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。