CreateAgent - 创建 Agent - 大数据开发治理平台 DataWorks

创建 Agent

接口说明

请求说明

Agent 名称：必须在当前账号下唯一。
模型配置：可选参数，用于指定 Agent 使用的模型及其相关设置。
可见性级别：定义了谁可以访问该 Agent，支持账号内、项目或特定用户可见。
可见性范围：当选择 PROJECT 或 USER 作为可见性级别时，需要进一步指定具体的项目 ID 或用户 ID 列表。
其他参数：如展示名称、描述等为非必填项，可根据实际需求填写。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

dataworks:CreateAgent

create

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
Name	string	是	Agent 名称，在当前账号下唯一。	my-agent
DisplayName	string	否	Agent 展示名称。	我的助手
Description	string	否	Agent 描述。	数据分析助手
Model	object	否	模型配置。	{ "modelName": "dataworks-public-bailian/qwen-max" }
SystemPrompt	string	否	系统提示词。	你是一个数据分析助手。
Tools	array<object>	否	工具列表。	-
	object	否	工具信息。	-
Name	string	否	McpServer 名称	server-1
Skills	array<object>	否	技能列表。	-
	object	否	技能配置	["my-skill"]
Name	string	否	Skill 名称	skill-1
CallableAgents	array<object>	否	可被本 Agent 调用的子 Agent 列表。	-
	object	否	agent 名称	["agent-name"]
Name	string	否	Agent 名称	agent-1
Metadata	object	否	扩展元数据（键值对）。	{}
Visibility	string	否	可见性级别。 `TENANT`：账号内可见； `PROJECT`：指定项目可见； `USER`：指定用户可见。	TENANT
VisibilityScope	object	否	可见性范围，按 Visibility 取对应字段。
ProjectIds	array	否	可见的项目 ID 列表，Visibility 为 `PROJECT` 时生效。
	string	否	工作空间 ID 列表	[21791]
UserIds	array	否	可见的用户 ID 列表，Visibility 为 `USER` 时生效。
	string	否	可见的用户 ID 列表，Visibility 为 USER 时生效。	[]

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID。	824F80BA-1778-5D8A-BAFF-668A4D9C4CC7
Agent	object	创建的 Agent 详情
Name	string	Agent 名称。	my-agent
GmtCreateTime	string	创建时间（毫秒时间戳）。	1780555634000
GmtModifiedTime	string	最近修改时间（毫秒时间戳）。	1780555634000

示例

正常返回示例

JSON格式

{
  "RequestId": "824F80BA-1778-5D8A-BAFF-668A4D9C4CC7",
  "Agent": {
    "Name": "my-agent",
    "GmtCreateTime": "1780555634000",
    "GmtModifiedTime": "1780555634000"
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。