全部產品
Search
文件中心

DataWorks:GetAgent - 讀取 Agent 詳情

更新時間:Jun 06, 2026

根據名稱讀取單個 Agent 的詳細資料。

介面說明

請求說明

該 API 用於通過指定的 Agent 名稱來擷取其詳細的配置資訊,包括但不限於模型配置、系統提示詞、工具列表等。請求時需要提供準確的 Agent 名稱作為參數。

調試

您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

當前API暫無授權資訊透出。

請求參數

名稱

類型

必填

描述

樣本值

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 時有效。

builtin_sql

McpServerName

string

關聯的 MCP Server 名稱,Kind 為 mcp 時有效。

server-name

McpItems

array

選用的 MCP 工具項,Kind 為 mcp 時有效。

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

可見的使用者識別碼 列表。

string

使用者識別碼

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"
  }
}

錯誤碼

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

變更歷史

更多資訊,參考變更詳情