Obter um Agent - Qoder CN Series: Central de Documentação do Alibaba Cloud

Recupere os detalhes de um Agent específico por ID.

GET /api/v1/cloud/agents/{agent_id}

Retorna os detalhes do Agent especificado.

Cabeçalhos da requisição

Cabeçalho	Obrigatório	Descrição
`Authorization`	Sim	`Bearer <PAT>`

Parâmetros de caminho

Parâmetro	Tipo	Obrigatório	Descrição
`agent_id`	string	Sim	Identificador exclusivo do Agent, com prefixo `agent_`

Parâmetros de consulta

Parâmetro	Tipo	Obrigatório	Descrição
`version`	integer	Não	Retorna o snapshot do Agent na versão especificada; omita para retornar o Agent atual

Exemplo de requisição

curl -X GET "https://api.qoder.com.cn/api/v1/cloud/agents/agent_019eXXXXXXXXXXXXXXXXXXXXXXXXXXXX" \
  -H "Authorization: Bearer $QODER_PAT"

Exemplo de resposta

HTTP 200 OK

{
  "type": "agent",
  "id": "agent_019eXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
  "name": "doc-test-agent",
  "description": "",
  "model": "ultimate",
  "system": "You are the documentation testing assistant.",
  "tools": [],
  "mcp_servers": [],
  "skills": [
    {"type": "custom", "skill_id": "skill_019e5d133c057536872f745e0b6dbd5d"}
  ],
  "metadata": {},
  "multiagent": null,
  "version": 1,
  "archived_at": null,
  "created_at": "2026-05-18T15:26:39.61669Z",
  "updated_at": "2026-05-18T15:26:39.61669Z"
}

Campos da resposta

Sem o parâmetro version, a resposta retorna o objeto do Agent atual. Com o parâmetro version, a resposta consiste em um snapshot da versão do Agent.

Campo	Tipo	Descrição
`type`	string	Sempre `"agent"`
`id`	string	Identificador exclusivo do Agent
`name`	string	Nome do Agent
`description`	string	Descrição do Agent
`model`	string \	object	Identificador do modelo. Consulte Modelo do Agent para obter detalhes
`system`	string	Prompt do sistema
`tools`	Array de ferramentas do Agent	Lista de configurações de ferramentas
`mcp_servers`	Array de servidores MCP	Configuração de servidores MCP
`skills`	Array de vinculações de skills	Vinculações de skills
`metadata`	Objeto de metadados	Metadados personalizados
`multiagent`	Multiagent \	null	Configuração de agents; `null` quando não defina
`version`	integer	Número da versão atual
`archived_at`	string \	null	Data e hora de arquivamento (ISO 8601); `null` quando não arquivado
`created_at`	string	Data e hora de criação (ISO 8601)
`updated_at`	string	Data e hora da última atualização (ISO 8601)

Erros

HTTP	type	Gatilho
400	`invalid_request_error`	`version` não é um número inteiro positivo
401	`authentication_error`	PAT inválido ou expirado
403	`permission_error`	Sem autorização para acessar este Agent
404	`not_found_error`	O Agent com o ID especificado não existe

Exemplo de resposta de erro:

{
  "type": "error",
  "request_id": "cb80235f-76a2-4ff3-9e28-5aa2da12dc14",
  "error": {
    "type": "not_found_error",
    "message": "Agent 'agent_nonexistent' was not found."
  }
}