Arquivar um agente - Qoder CN Series: Central de Documentação do Alibaba Cloud

Arquive um Agent específico. Agents arquivados não aparecem na lista padrão, mas permanecem acessíveis por ID.

POST /api/v1/cloud/agents/{agent_id}/archive

Arquive um Agent específico. Após o arquivamento, o Agent deixa de aparecer na lista padrão, mas ainda é acessível diretamente pelo 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 Agent

Corpo da requisição

Corpo de requisição desnecessário.

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": "For API documentation testing",
  "model": "ultimate",
  "system": "You are the updated documentation testing assistant.",
  "tools": [],
  "mcp_servers": [],
  "skills": [],
  "metadata": {},
  "multiagent": null,
  "version": 2,
  "archived_at": "2026-05-18T15:27:22.698411Z",
  "created_at": "2026-05-18T15:26:39.61669Z",
  "updated_at": "2026-05-18T15:27:22.698411Z"
}

Campos da resposta

Retorna o objeto completo do Agent após o arquivamento. O campo updated_at assume o horário da operação de arquivamento.

Campo	Tipo	Descrição
`type`	string	Valor fixo `"agent"`
`id`	string	Identificador exclusivo do Agent
`name`	string	Nome do Agent
`description`	string	Descrição do Agent
`model`	string	Identificador do modelo
`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 servidor MCP
`skills`	Array de vinculação de skills	Lista de vinculações de skills
`metadata`	Objeto de metadados	Metadados personalizados
`multiagent`	Multiagent \	null	Configuração multiagente. `null` quando não definido
`version`	integer	Número da versão atual
`archived_at`	string\	null	Timestamp de arquivamento (ISO 8601). `null` se não estiver arquivado
`created_at`	string	Timestamp de criação (ISO 8601)
`updated_at`	string	Timestamp da última atualização (ISO 8601); renovado durante o arquivamento

Erros

HTTP	type	Condição
401	`authentication_error`	PAT inválido ou expirado
403	`permission_error`	Permissões insuficientes para arquivar este Agent
404	`not_found_error`	O Agent com o ID especificado não existe

Observações

O arquivamento preserva os dados do Agent
Agents arquivados não constam na lista padrão retornada por GET /api/v1/cloud/agents
Adicione include_archived=true à chamada GET /api/v1/cloud/agents para listar Agents arquivados
Consulte Agents arquivados diretamente via GET /api/v1/cloud/agents/{agent_id}
A operação de arquivamento é idempotente; arquivar um Agent já arquivado não gera erro
O arquivamento não incrementa a version do Agent nem cria um novo snapshot de versão