Todos os produtos
Search
Central de documentação

DataWorks:GetAgent

Última atualização: Jun 26, 2026

Obtém os detalhes do agente por nome.

Descrição da operação

Solicitação

Esta API usa o nome de um agente, fornecido como parâmetro, para obter sua configuração detalhada, incluindo a configuração do modelo, o prompt do sistema e a lista de ferramentas.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

Nenhuma autorização necessária para esta operação. Se você encontrar problemas com esta operação, entre em contato com o suporte técnico.

Parâmetros da solicitação

Parâmetro

Tipo

Obrigatório

Descrição

Exemplo

Name

string

Sim

O nome da habilidade a ser obtida.

my-skill

Elementos de resposta

Elemento

Tipo

Descrição

Exemplo

object

Os parâmetros de resposta.

RequestId

string

O ID da solicitação.

824F80BA-1778-5D8A-BAFF-668A4D9C4CC7

Agent

object

Os detalhes do agente.

CreatorId

string

O ID do criador.

123456

ModifierId

string

O ID do último modificador.

123456

Name

string

O nome do agente..

my-agent

DisplayName

string

O nome de exibição..

我的助手

Description

string

A descrição..

数据分析助手

Model

object

A configuração do modelo..

ModelName

string

The model name.

qwen3-max

Temperature

number

The temperature.

1

TopP

number

The top-p.

1

MaxTokens

integer

The maximum number of tokens to generate in one response.

8192

Stream

boolean

Indicates whether streaming output is enabled.

true

Config

object

Additional configuration for the model.

{}

SystemPrompt

string

O prompt do sistema..

你是一个数据分析助手。

Tools

array<object>

Uma lista de ferramentas..

object

Kind

string

The tool type.

builtin

BuiltinName

string

The name of the built-in tool. This parameter applies only when Kind is set to builtin.

builtin_sql

McpServerName

string

The name of the associated MCP server. This parameter applies only when Kind is set to mcp.

server-name

McpItems

array

The selected MCP tool items. This parameter applies only when Kind is set to mcp.

string

The name of a tool. If the McpItems array is empty or not provided, all tools are selected by default.

search_table

Skills

array<object>

Uma lista de habilidades.

object

Name

string

The skill name.

my-skill

Version

integer

The skill version.

-

CallableAgents

array<object>

Uma lista de subagentes chamáveis.

object

Name

string

The sub-agent name.

sub-agent

DisplayName

string

The sub-agent display name.

子助手

Version

integer

The sub-agent version.

-

Source

string

The sub-agent source.

custom

RequiredRuntime

array

As dependências de tempo de execução.

string

Uma dependência de tempo de execução.

-

Metadata

object

Metadados adicionais..

{}

Visibility

string

O nível de visibilidade..

TENANT

VisibilityScope

object

O escopo de visibilidade.

ProjectIds

array

A list of project IDs that can view the agent.

string

A project ID.

proj_001

UserIds

array

A list of user IDs that can view the agent.

string

A user ID.

123456

GmtCreateTime

string

A hora de criação, como um timestamp Unix em milissegundos.

1780555634000

GmtModifiedTime

string

A hora da última modificação, como um timestamp Unix em milissegundos.

1780555634000

Exemplos

Resposta de sucesso

JSON formato

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

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.