:Define an Agent

Conceitos fundamentais

Pense em um Agent como uma "descrição de cargo":

O Agent em si não executa tarefas — trata-se apenas de uma configuração. A execução das tarefas fica a cargo de uma Session vinculada a esse Agent.

Referência de parâmetros

Model

O campo model especifica o modelo utilizado pelo Agent.

Tools

O campo tools é um array de objetos de ferramentas. Atualmente, apenas o toolset agent_toolset_20260401 é suportado. Para ativar ferramentas atômicas dentro desse toolset, liste-as no array enabled_tools:

{
  "tools": [
    {
      "type": "agent_toolset_20260401",
      "enabled_tools": ["Bash", "Read", "Write", "Edit", "Glob", "Grep", "WebFetch", "WebSearch"]
    }
  ]
}

Valores disponíveis para enabled_tools (os valores diferenciam maiúsculas de minúsculas e devem estar em PascalCase):

Para mais configurações de ferramentas, consulte Agent Tool Configuration.

gerencie agents

Para todas as operações CRUD, consulte API Reference / Agents. Os exemplos a seguir cobrem fluxos de trabalho comuns.

crie

curl -s -X POST https://api.qoder.com.cn/api/v1/cloud/agents \
  -H "Authorization: Bearer $QODER_PAT" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "code-reviewer",
    "model": "auto",
    "instructions": "You are a code review expert. Review the code line by line and output issues and improvement suggestions in Markdown.",
    "tools": [
      {
        "type": "agent_toolset_20260401",
        "enabled_tools": ["Bash", "Read", "Write"]
      }
    ],
    "metadata": {
      "team": "backend",
      "purpose": "code-review"
    }
  }' | jq .

Uma requisição bem-sucedida retorna 201 Created. O campo version inicia em 1.

Consultar

# Get a single Agent
curl -s https://api.qoder.com.cn/api/v1/cloud/agents/agent_xxx \
  -H "Authorization: Bearer $QODER_PAT"

# List Agents with pagination
curl -s "https://api.qoder.com.cn/api/v1/cloud/agents?limit=20" \
  -H "Authorization: Bearer $QODER_PAT"

atualize

Ao atualizar um Agent, é obrigatório informar a version atual. Para mais informações, consulte Gerenciamento de versões abaixo.

curl -s -X PUT https://api.qoder.com.cn/api/v1/cloud/agents/agent_xxx \
  -H "Authorization: Bearer $QODER_PAT" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "code-reviewer",
    "model": "auto",
    "instructions": "You are a senior code review expert, focusing on security vulnerabilities and performance issues.",
    "version": 1
  }' | jq .

Uma requisição bem-sucedida retorna 200 OK, e o campo version é incrementado em 1.

exclua

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

exclua um Agent não encerra Sessions ativas vinculadas a ele. A Session captura um snapshot da configuração do Agent no momento da criação.

Gerenciamento de versões

A API de Agent utiliza controle de concorrência otimista (OCC):

• O campo version inicia em 1 na criação.

• Após cada atualização bem-sucedida, o campo version é incrementado automaticamente em 1.

• As requisições de atualização devem incluir a version atual. Dois cenários de falha:

  • Campo version ausente — retorna 400 invalid_request_error ("Field 'version' is required.")

  • O campo version está presente, mas não corresponde à versão no servidor — retorna 409 conflict_error

Esse mecanismo impede que modificações concorrentes sobrescrevam umas às outras.

Tratando conflitos 409

Se a requisição falhar porque a versão está desatualizada, você receberá o seguinte erro:

{
  "type": "error",
  "error": {
    "type": "conflict_error",
    "message": "Version conflict. Expected version 2, got 1."
  }
}

Para resolver o conflito:

1. Faça um GET no Agent mais recente para obter a version atual.

2. Reaplique as alterações desejadas sobre os dados mais recentes do objeto.

3. Use a nova version para executar outro PUT.

Práticas recomendadas

1. Convenções de nomenclatura — Utilize o formato team-purpose, como backend-code-review ou frontend-test-gen.

2. Refinamento do prompt — Especifique a função, o formato de saída e as restrições no campo system.

3. Aplique o princípio do menor privilégio: conceda apenas as tools essenciais para a tarefa, minimizando riscos.

4. Use metadata de forma eficaz: adicione pares de chave-valor para categorizar Agents e facilitar a filtragem e a auditoria.

5. Travamento de versão em produção — Ao criar uma Session, use o formato {"id": ..., "version": ...} para travar a versão do Agent. Isso evita que novas versões afetem seus service em produção.

Perguntas frequentes

P: atualize um Agent afeta Sessions em execução?Não. A Session é vinculada a uma versão específica do Agent no momento da criação.P: O array tools pode ficar vazio?Sim. Um Agent sem tools consegue apenas manter conversas baseadas em texto, sem executar ações.P: Existe um limite de comprimento para o campo name?Mantenha até 64 caracteres, usando letras minúsculas, números e hifens.P: Como reverter para uma versão anterior do Agent?A reversão automática não é suportada. salve a configuração do Agent antes de atualizá-lo. Para reverter, faça um PUT com a configuração antiga usando o número de version mais recente.