GetAgent - GetAgent-DataWorks(DataWorks)-阿里云帮助中心

Retrieves agent details by name.

Operation description

Request

Specify an agent name to retrieve its detailed configuration, including the model configuration, system prompt, and tool list.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
Name	string	Yes	The name of the skill to retrieve.	my-skill

Response elements

Element	Type	Description	Example
	object	Response parameters
RequestId	string	The request ID.	824F80BA-1778-5D8A-BAFF-668A4D9C4CC7
Agent	object	The details of the agent.
CreatorId	string	The creator ID.	123456
ModifierId	string	The ID of the user who last modified the agent.	123456
Name	string	The agent name.	my-agent
DisplayName	string	The display name.	My Assistant
Description	string	The description.	Data analysis assistant
Model	object	The model configuration.
ModelName	string	The model name.	qwen3-max
Temperature	number	The sampling temperature.	1
TopP	number	The nucleus sampling Top-P value.	1
MaxTokens	integer	The maximum number of tokens for a single output.	8192
Stream	boolean	Specifies whether to enable streaming output.	true
Config	object	The additional model configuration.	{}
SystemPrompt	string	The system prompt.	You are a data analysis assistant.
Tools	array	The tool list.
	object
Kind	string	The tool type.	builtin
BuiltinName	string	The built-in tool name. This parameter is valid only when Kind is set to `builtin`.	builtin_sql
McpServerName	string	The associated MCP server name. This parameter is valid only when Kind is set to `mcp`.	server-name
McpItems	array	The selected MCP tool items. This parameter is valid only when Kind is set to `mcp`.
	string	The tool name. Default value: all.	search_table
Skills	array	The skill list.
	object
Name	string	The skill name.	my-skill
Version	integer	The skill version number.	-
CallableAgents	array	The list of callable sub-agents.
	object
Name	string	The sub-agent name.	sub-agent
DisplayName	string	The display name of the sub-agent.	Sub Assistant
Version	integer	The version number of the sub-agent.	-
Source	string	The source of the sub-agent.	custom
RequiredRuntime	array	The required runtime dependencies.
	string	Empty	-
Metadata	object	The extended metadata.	{}
Visibility	string	The visibility level.	TENANT
VisibilityScope	object	The visibility scope.
ProjectIds	array	The list of visible project IDs.
	string	The project ID.	proj_001
UserIds	array	The list of visible user IDs.
	string	The user ID.	123456
GmtCreateTime	string	The creation time, in millisecond-level timestamp format.	1780555634000
GmtModifiedTime	string	The last modification time, in millisecond-level timestamp format.	1780555634000

Examples

Success response

JSON format

{
  "RequestId": "824F80BA-1778-5D8A-BAFF-668A4D9C4CC7",
  "Agent": {
    "CreatorId": "123456",
    "ModifierId": "123456",
    "Name": "my-agent",
    "DisplayName": "My Assistant",
    "Description": "Data analysis assistant",
    "Model": {
      "ModelName": "qwen3-max",
      "Temperature": 1,
      "TopP": 1,
      "MaxTokens": 8192,
      "Stream": true,
      "Config": {}
    },
    "SystemPrompt": "You are a data analysis assistant.",
    "Tools": [
      {
        "Kind": "builtin",
        "BuiltinName": "builtin_sql",
        "McpServerName": "server-name",
        "McpItems": [
          "search_table"
        ]
      }
    ],
    "Skills": [
      {
        "Name": "my-skill",
        "Version": 0
      }
    ],
    "CallableAgents": [
      {
        "Name": "sub-agent",
        "DisplayName": "Sub Assistant",
        "Version": 0,
        "Source": "custom"
      }
    ],
    "RequiredRuntime": [
      "-"
    ],
    "Metadata": {},
    "Visibility": "TENANT",
    "VisibilityScope": {
      "ProjectIds": [
        "proj_001"
      ],
      "UserIds": [
        "123456"
      ]
    },
    "GmtCreateTime": "1780555634000",
    "GmtModifiedTime": "1780555634000"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.