Referência da API

Agents

Crie e versiona configurações de agents dentro de um projeto.

#Endpoints

MétodoCaminhoDescrição
POST/v1/projects/:projectId/agentsCria um agent e publica a versão 1.
POST/v1/projects/:projectId/agents/:idAplica patch com lock otimista e publica nova versão.
POST/v1/projects/:projectId/agents/:id/archiveArquiva o agent.
GET/v1/projects/:projectId/agents/:id/versionsLista versões por cursor.
GET/v1/projects/:projectId/agents/:idLê a versão atual ou uma versão específica.
GET/v1/projects/:projectId/agentsLista agents por cursor, com filtro opcional por nome.

#Criar agent

ts
const agent = await client.agents.create({
name: 'Assistente operacional',
model: 'anthropic/claude-haiku-4-5',
system: 'Responda com clareza e peça dados faltantes antes de concluir.',
tools: ['web_search', 'memory_read'],
});

#Atualizar agent

Atualizações exigem a version atual. Se outra mudança publicou uma versão mais nova, a API retorna conflito.

ts
const updated = await client.agents.update(agent.id, {
  version: agent.version,
  system: 'Responda com clareza, peça dados faltantes e cite fontes quando pesquisar.',
});

#Campos principais

CampoTipoObservação
namestringNome de 1 a 200 caracteres.
descriptionstringOpcional, para humanos.
modelstring ou objetoIdentifica provedor e modelo.
systemstringInstruções persistentes.
toolsarrayBuilt-ins por string ou custom tools serializadas.
mcpServersarrayServidores MCP com name, url e headers opcionais.
toolPermissionsobjectalways_allow ou always_ask por tool.
metadataobjectPares string → string.

#Conceitos relacionados