CreateAgent - 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`：指定使用者可見。枚舉值： PROJECT : 專案。 USER : 使用者。 TENANT : 租戶。	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"
  }
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。