Arquivar um agente - AI Coding Assistant Lingma: Central de Documentação do Alibaba Cloud

Arquive um agente para ocultá-lo da listagem padrão e mantê-lo acessível por ID.

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 agente.

Corpo da requisição

Esta requisição não exige corpo.

Exemplo de requisição

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

Exemplo de resposta

HTTP 200 OK

{
  "type": "agent",
  "id": "agent_019eXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
  "name": "doc-test-agent-updated",
  "description": "Used for API documentation testing",
  "model": "ultimate",
  "system": "You are the updated documentation testing assistant.",
  "instructions": "You are the updated documentation testing assistant.",
  "tools": [],
  "mcp_servers": [],
  "default_environment": "",
  "version": 2,
  "created_at": "2026-05-18T15:26:39.61669Z",
  "updated_at": "2026-05-18T15:27:22.698411Z"
}

Campos da resposta

A API retorna o objeto completo do agente após o arquivamento. O campo updated_at passa a refletir o horário da operação.

Campo	Tipo	Descrição
`type`	string	Sempre `"agent"`.
`id`	string	Identificador exclusivo do agente.
`name`	string	Nome do agente.
`description`	string	Descrição do agente.
`model`	string	Identificador do modelo.
`instructions`	string	Prompt do sistema.
`system`	string	Alias de `instructions`. Obsoleto; use `instructions`.
`tools`	array	Configuração de ferramentas.
`mcp_servers`	array	Configuração de servidores MCP.
`default_environment`	string	Ambiente de execução padrão.
`version`	integer	Número da versão atual.
`created_at`	string	Horário de criação em ISO 8601.
`updated_at`	string	Horário da última atualização em ISO 8601. Atualizado no arquivamento.

Erros

HTTP	Tipo	Causa
401	`authentication_error`	PAT inválido ou expirado.
403	`permission_error`	Permissão insuficiente para arquivar este agente.
404	`not_found_error`	Agente com o ID especificado não encontrado.

Consulte Erros para ver a estrutura completa de erros.

Arquivar vs. exclua

Ação	Efeito	Recuperável
Arquivar	Oculta o agente da listagem padrão e preserva os dados.	Sim (desarquivamento suportado).
Excluir	Remove o agente permanentemente.	Não.

Observações

O arquivamento atua como exclusão lógica; os dados do agente permanecem no sistema.
Agentes arquivados não constam na resposta padrão de GET /v1/agents.
É possível recuperar agentes arquivados via GET /v1/agents/{agent_id}.
A operação é idempotente: arquivar um agente já arquivado não gera erro.