API Agents — agentes, copilotos, ações e execução de tarefas
Referência de Agents para integrar as operações descritas abaixo.
Guia principal e downloads · Exemplos · Endpoints
Índice clicável
Configuração de agentes conversacionais — AgenteConversacional · Catálogo de ações — AgenteAcaoCatalogo · Conhecimento dos agentes — AgenteConhecimento · Logs de execução — AgenteExecucaoLog · Tarefas elegíveis para IA — AgenteTarefas · Agente de perguntas e respostas — AgenteQnaConfig · Feedback de respostas — AgenteRespostaFeedback · Configuração de agentes de tarefa — TipoTarefaAgenteConfig · Ações HTTP customizadas — AcaoCustomizada · Configuração de copilotos — AgenteInterno · Métricas e sessões de copilotos — Copiloto · Métricas e sessões conversacionais — ConversacionalDashboard · Ambiente de teste de agentes — AgentesSandbox · Cadências de follow-up — FollowUp
Como usar esta referência
API central: https://{tenant}.api.groner.app. Use API_URL com o host da empresa, sem /api. Envie Bearer. O middleware retorna o envelope Content; tabelas avançadas, downloads e 204 possuem transporte próprio. A operação e a função do usuário determinam o acesso.
Substitua tenant/token pelo ambiente autorizado e IDs de exemplo pelos cadastros reais. Os comandos são Bash; no PowerShell use curl.exe e adapte variáveis e continuação de linha.
Recursos compartilhados: a organização segue a finalidade principal da operação, não exclusividade de produto. Um client consumir um controller não significa que todas as actions desse controller sejam liberadas para aquele usuário. Consulte guard e contrato.
Exemplos de requisição e resposta
Consultar agentes conversacionais
Requisição completa (Bash):
curl --request GET \
--url "$API_URL/api/configuracoes/AgenteConversacional" \
--header "Authorization: Bearer $TOKEN" \
--header "Accept: application/json"Resposta ilustrativa — HTTP 200:
{
"Version": "1.0.0.0",
"StatusCode": 200,
"Message": "Requisição efetuada com suceesso.",
"Content": []
}Pausar um agente autorizado
Requisição completa (Bash):
curl --request POST \
--url "$API_URL/api/configuracoes/AgenteConversacional/123/pausar" \
--header "Authorization: Bearer $TOKEN" \
--header "Accept: application/json"Resposta ilustrativa — HTTP 204:
Sem corpo. Não tente desserializar JSON nesta resposta.
O ID 123 é fictício. A configuração conversacional exige Administrador. Teste de ação customizada executa HTTP real; o sandbox pode executar ferramentas reais. AgentesSandbox possui rotas próprias em /api/sandbox, distintas do sandbox dentro da configuração de um agente.
Referência dos endpoints
Configuração de agentes conversacionais — AgenteConversacional
Uso encontrado nos clients: Groner agent-front. Compartilhamento não amplia permissões.
GET /api/configuracoes/AgenteConversacional
query status: StatusAgenteEnum?.
Retorno declarado: Task<IActionResult>. Acesso: Bearer; perfis declarados: Administrador.
GET /api/configuracoes/AgenteConversacional/{id}
path id: long.
Retorno declarado: Task<IActionResult>. Acesso: Bearer; perfis declarados: Administrador.
DELETE /api/configuracoes/AgenteConversacional/{id}
path id: long.
Retorno declarado: Task<IActionResult>. Acesso: Bearer; perfis declarados: Administrador.
POST /api/configuracoes/AgenteConversacional
body body: AgenteConversacionalInputDTO — AgenteConversacionalInputDTO.
Retorno declarado: Task<IActionResult>. Acesso: Bearer; perfis declarados: Administrador.
PUT /api/configuracoes/AgenteConversacional/{id}
path id: long; body body: AgenteConversacionalInputDTO — AgenteConversacionalInputDTO.
Retorno declarado: Task<IActionResult>. Acesso: Bearer; perfis declarados: Administrador.
POST /api/configuracoes/AgenteConversacional/{id}/ativar
path id: long.
Retorno declarado: Task<IActionResult>. Acesso: Bearer; perfis declarados: Administrador.
POST /api/configuracoes/AgenteConversacional/{id}/pausar
path id: long.
Retorno declarado: Task<IActionResult>. Acesso: Bearer; perfis declarados: Administrador.
POST /api/configuracoes/AgenteConversacional/{id}/canais
path id: long; body body: AgenteConversacionalCanalInputDTO — AgenteConversacionalCanalInputDTO.
Retorno declarado: Task<IActionResult>. Acesso: Bearer; perfis declarados: Administrador.
DELETE /api/configuracoes/AgenteConversacional/canais/{canalId}
path canalId: long.
Retorno declarado: Task<IActionResult>. Acesso: Bearer; perfis declarados: Administrador.
GET /api/configuracoes/AgenteConversacional/{id}/historico
path id: long.
Retorno declarado: Task<IActionResult>. Acesso: Bearer; perfis declarados: Administrador.
POST /api/configuracoes/AgenteConversacional/{id}/sandbox/conversar
path id: long; body body: SandboxConversarInputDTO — SandboxConversarInputDTO.
Retorno declarado: Task<IActionResult>. Acesso: Bearer; perfis declarados: Administrador.
Catálogo de ações — AgenteAcaoCatalogo
Uso encontrado nos clients: Groner agent-front. Compartilhamento não amplia permissões.
GET /api/configuracoes/agentes/catalogo-acoes
Sem parâmetros de cliente declarados na assinatura; confira transportes especiais na operação..
Retorno declarado: Task<IActionResult>. Acesso: Bearer; perfis declarados: Administrador.
Conhecimento dos agentes — AgenteConhecimento
Uso encontrado nos clients: Groner agent-front. Compartilhamento não amplia permissões.
GET /api/configuracoes/AgenteConversacional/{agenteId}/conhecimento
path agenteId: long.
Retorno declarado: Task<IActionResult>. Acesso: Bearer; perfis declarados: Administrador.
POST /api/configuracoes/AgenteConversacional/{agenteId}/conhecimento/upload
path agenteId: long; form arquivo: IFormFile.
Retorno declarado: Task<IActionResult>. Acesso: Bearer; perfis declarados: Administrador.
Transporte: multipart/form-data.
GET /api/configuracoes/AgenteConversacional/{agenteId}/conhecimento/{arquivoId}/download
path agenteId: long; path arquivoId: long.
Retorno declarado: Task<IActionResult>. Acesso: Bearer; perfis declarados: Administrador.
DELETE /api/configuracoes/AgenteConversacional/{agenteId}/conhecimento/{arquivoId}
path agenteId: long; path arquivoId: long.
Retorno declarado: Task<IActionResult>. Acesso: Bearer; perfis declarados: Administrador.
POST /api/configuracoes/AgenteConversacional/{agenteId}/conhecimento/sincronizar
path agenteId: long.
Retorno declarado: Task<IActionResult>. Acesso: Bearer; perfis declarados: Administrador.
GET /api/configuracoes/AgenteConversacional/{agenteId}/conhecimento/sincronizacao/status
path agenteId: long.
Retorno declarado: Task<IActionResult>. Acesso: Bearer; perfis declarados: Administrador.
Logs de execução — AgenteExecucaoLog
Uso encontrado nos clients: Groner agent-front. Compartilhamento não amplia permissões.
GET /api/configuracoes/agentes/execucoes
query tarefaId: long?; query agenteTipo: AgenteTipoEnum?; query status: AgenteExecucaoStatusEnum?; query pageNumber: int (padrão 1); query pageSize: int (padrão 20).
Retorno declarado: Task<IActionResult>. Acesso: Bearer; perfis declarados: Administrador,Gerente,Supervisor.
POST /api/configuracoes/agentes/execucoes/{id}/aprovar
path id: long.
Retorno declarado: Task<IActionResult>. Acesso: Bearer; perfis declarados: Administrador,Gerente,Supervisor.
POST /api/configuracoes/agentes/execucoes/{id}/rejeitar
path id: long.
Retorno declarado: Task<IActionResult>. Acesso: Bearer; perfis declarados: Administrador,Gerente,Supervisor.
Tarefas elegíveis para IA — AgenteTarefas
Uso encontrado nos clients: Groner agent-front. Compartilhamento não amplia permissões.
GET /api/configuracoes/agentes/tarefas
query tipoTarefaId: long?; query statusId: long?; query busca: string; query pageNumber: int (padrão 1); query pageSize: int (padrão 20).
Retorno declarado: Task<IActionResult>. Acesso: Bearer; perfis declarados: Administrador,Gerente,Supervisor.
GET /api/configuracoes/agentes/tarefas/{id}
path id: long.
Retorno declarado: Task<IActionResult>. Acesso: Bearer; perfis declarados: Administrador,Gerente,Supervisor.
Agente de perguntas e respostas — AgenteQnaConfig
Uso encontrado nos clients: Groner agent-front. Compartilhamento não amplia permissões.
GET /api/configuracoes/agentes/qna
Sem parâmetros de cliente declarados na assinatura; confira transportes especiais na operação..
Retorno declarado: Task<IActionResult>. Acesso: Bearer; perfis declarados: Administrador.
PUT /api/configuracoes/agentes/qna
body body: AgenteQnaConfig — AgenteQnaConfig.
Retorno declarado: Task<IActionResult>. Acesso: Bearer; perfis declarados: Administrador.
Feedback de respostas — AgenteRespostaFeedback
Uso encontrado nos clients: Groner agent-front. Compartilhamento não amplia permissões.
GET /api/configuracoes/agentes/conversacional/feedback/motivos
Sem parâmetros de cliente declarados na assinatura; confira transportes especiais na operação..
Retorno declarado: IActionResult. Acesso: Bearer; perfis declarados: Administrador,Gerente,Supervisor.
POST /api/configuracoes/agentes/conversacional/feedback
Motivos disponíveis pro polegar pra baixo (valor + rótulo). O front consome daqui em vez de manter cópia do enum.
body body: RespostaFeedbackInputDTO — RespostaFeedbackInputDTO.
Retorno declarado: Task<IActionResult>. Acesso: Bearer; perfis declarados: Administrador,Gerente,Supervisor.
DELETE /api/configuracoes/agentes/conversacional/feedback/{id}
path id: long.
Retorno declarado: Task<IActionResult>. Acesso: Bearer; perfis declarados: Administrador,Gerente,Supervisor.
GET /api/configuracoes/agentes/conversacional/feedback
query dataInicial: DateTime?; query dataFinal: DateTime?; query agenteConversacionalId: long?; query sinal: string; query motivo: string; query status: string; query pageNumber: int (padrão 1); query pageSize: int (padrão 20).
Retorno declarado: Task<IActionResult>. Acesso: Bearer; perfis declarados: Administrador,Gerente,Supervisor.
GET /api/configuracoes/agentes/conversacional/feedback/resumo
query dataInicial: DateTime?; query dataFinal: DateTime?; query agenteConversacionalId: long?.
Retorno declarado: Task<IActionResult>. Acesso: Bearer; perfis declarados: Administrador,Gerente,Supervisor.
Configuração de agentes de tarefa — TipoTarefaAgenteConfig
Uso encontrado nos clients: Groner agent-front. Compartilhamento não amplia permissões.
GET /api/configuracoes/TipoTarefaAgenteConfig
Sem parâmetros de cliente declarados na assinatura; confira transportes especiais na operação..
Retorno declarado: Task<IActionResult>. Acesso: Bearer; perfis declarados: Administrador.
GET /api/configuracoes/TipoTarefaAgenteConfig/{tipoTarefaId}
path tipoTarefaId: long.
Retorno declarado: Task<IActionResult>. Acesso: Bearer; perfis declarados: Administrador.
POST /api/configuracoes/TipoTarefaAgenteConfig
body body: TipoTarefaAgenteConfig — TipoTarefaAgenteConfig.
Retorno declarado: Task<IActionResult>. Acesso: Bearer; perfis declarados: Administrador.
PUT /api/configuracoes/TipoTarefaAgenteConfig/{id}
path id: long; body body: TipoTarefaAgenteConfig — TipoTarefaAgenteConfig.
Retorno declarado: Task<IActionResult>. Acesso: Bearer; perfis declarados: Administrador.
GET /api/configuracoes/TipoTarefaAgenteConfig/{id}/historico
path id: long.
Retorno declarado: Task<IActionResult>. Acesso: Bearer; perfis declarados: Administrador.
Ações HTTP customizadas — AcaoCustomizada
Uso encontrado nos clients: Groner agent-front. Compartilhamento não amplia permissões.
GET /api/configuracoes/agentes/acoes-customizadas
Sem parâmetros de cliente declarados na assinatura; confira transportes especiais na operação..
Retorno declarado: Task<ActionResult<List<AcaoCustomizadaOutputDTO>>>. Acesso: Bearer; perfis declarados: Administrador.
GET /api/configuracoes/agentes/acoes-customizadas/{id}
path id: long.
Retorno declarado: Task<ActionResult<AcaoCustomizadaOutputDTO>>. Acesso: Bearer; perfis declarados: Administrador.
POST /api/configuracoes/agentes/acoes-customizadas
body body: AcaoCustomizadaInputDTO — AcaoCustomizadaInputDTO.
Retorno declarado: Task<ActionResult<AcaoCustomizadaOutputDTO>>. Acesso: Bearer; perfis declarados: Administrador.
PUT /api/configuracoes/agentes/acoes-customizadas/{id}
path id: long; body body: AcaoCustomizadaInputDTO — AcaoCustomizadaInputDTO.
Retorno declarado: Task<ActionResult<AcaoCustomizadaOutputDTO>>. Acesso: Bearer; perfis declarados: Administrador.
DELETE /api/configuracoes/agentes/acoes-customizadas/{id}
path id: long.
Retorno declarado: Task<IActionResult>. Acesso: Bearer; perfis declarados: Administrador.
POST /api/configuracoes/agentes/acoes-customizadas/testar
body body: AcaoCustomizadaTestarInputDTO — AcaoCustomizadaTestarInputDTO.
Retorno declarado: Task<ActionResult<AcaoCustomizadaTestarOutputDTO>>. Acesso: Bearer; perfis declarados: Administrador.
Configuração de copilotos — AgenteInterno
Uso encontrado nos clients: Groner agent-front. Compartilhamento não amplia permissões.
GET /api/configuracoes/AgenteInterno
query status: StatusAgenteEnum?.
Retorno declarado: Task<IActionResult>. Acesso: Bearer; perfis declarados: Administrador.
GET /api/configuracoes/AgenteInterno/{id}
path id: long.
Retorno declarado: Task<IActionResult>. Acesso: Bearer; perfis declarados: Administrador.
POST /api/configuracoes/AgenteInterno
body body: AgenteInternoInputDTO — AgenteInternoInputDTO.
Retorno declarado: Task<IActionResult>. Acesso: Bearer; perfis declarados: Administrador.
PUT /api/configuracoes/AgenteInterno/{id}
path id: long; body body: AgenteInternoInputDTO — AgenteInternoInputDTO.
Retorno declarado: Task<IActionResult>. Acesso: Bearer; perfis declarados: Administrador.
POST /api/configuracoes/AgenteInterno/{id}/ativar
path id: long.
Retorno declarado: Task<IActionResult>. Acesso: Bearer; perfis declarados: Administrador.
POST /api/configuracoes/AgenteInterno/{id}/pausar
path id: long.
Retorno declarado: Task<IActionResult>. Acesso: Bearer; perfis declarados: Administrador.
GET /api/configuracoes/AgenteInterno/catalogo-acoes
Sem parâmetros de cliente declarados na assinatura; confira transportes especiais na operação..
Retorno declarado: IActionResult. Acesso: Bearer; perfis declarados: Administrador.
POST /api/configuracoes/AgenteInterno/{id}/sandbox/conversar
path id: long; body body: SandboxConversarInternoInputDTO — SandboxConversarInternoInputDTO.
Retorno declarado: Task<IActionResult>. Acesso: Bearer; perfis declarados: Administrador.
Métricas e sessões de copilotos — Copiloto
Uso encontrado nos clients: Groner agent-front. Compartilhamento não amplia permissões.
GET /api/configuracoes/agentes/copiloto/eval/rodadas
Cockpit da suíte de estabilidade — EXCLUSIVO do usuário raiz (Id == 1), mesmo precedente do custo US$ no dashboard. O gate é server-side de propósito: esconder no front não é controle de acesso.
query pageNumber: int (padrão 1); query pageSize: int (padrão 20).
Retorno declarado: Task<IActionResult>. Acesso: Bearer; perfis declarados: Administrador,Gerente,Supervisor.
GET /api/configuracoes/agentes/copiloto/eval/rodadas/{id}
path id: long.
Retorno declarado: Task<IActionResult>. Acesso: Bearer; perfis declarados: Administrador,Gerente,Supervisor.
GET /api/configuracoes/agentes/copiloto/metricas
query dataInicial: DateTime?; query dataFinal: DateTime?; query agenteInternoId: long?.
Retorno declarado: Task<IActionResult>. Acesso: Bearer; perfis declarados: Administrador,Gerente,Supervisor.
GET /api/configuracoes/agentes/copiloto/sessoes
query dataInicial: DateTime?; query dataFinal: DateTime?; query usuarioId: long?; query agenteInternoId: long?; query status: string; query pageNumber: int (padrão 1); query pageSize: int (padrão 20).
Retorno declarado: Task<IActionResult>. Acesso: Bearer; perfis declarados: Administrador,Gerente,Supervisor.
GET /api/configuracoes/agentes/copiloto/sessoes/{sessionId}
path sessionId: string.
Retorno declarado: Task<IActionResult>. Acesso: Bearer; perfis declarados: Administrador,Gerente,Supervisor.
Métricas e sessões conversacionais — ConversacionalDashboard
Uso encontrado nos clients: Groner agent-front. Compartilhamento não amplia permissões.
GET /api/configuracoes/agentes/conversacional/metricas
query dataInicial: DateTime?; query dataFinal: DateTime?; query agenteConversacionalId: long?.
Retorno declarado: Task<IActionResult>. Acesso: Bearer; perfis declarados: Administrador,Gerente,Supervisor.
GET /api/configuracoes/agentes/conversacional/sessoes
query dataInicial: DateTime?; query dataFinal: DateTime?; query leadId: long?; query agenteConversacionalId: long?; query status: string; query pageNumber: int (padrão 1); query pageSize: int (padrão 20).
Retorno declarado: Task<IActionResult>. Acesso: Bearer; perfis declarados: Administrador,Gerente,Supervisor.
GET /api/configuracoes/agentes/conversacional/sessoes/{sessionId}
path sessionId: string.
Retorno declarado: Task<IActionResult>. Acesso: Bearer; perfis declarados: Administrador,Gerente,Supervisor.
GET /api/configuracoes/agentes/conversacional/conversas
query dataInicial: DateTime?; query dataFinal: DateTime?; query leadId: long?; query agenteConversacionalId: long?; query status: string; query pageNumber: int (padrão 1); query pageSize: int (padrão 20); query apenasComAtuacao: bool (padrão true).
Retorno declarado: Task<IActionResult>. Acesso: Bearer; perfis declarados: Administrador,Gerente,Supervisor.
GET /api/configuracoes/agentes/conversacional/conversas/{leadId}
path leadId: long; query dataInicial: DateTime?; query dataFinal: DateTime?.
Retorno declarado: Task<IActionResult>. Acesso: Bearer; perfis declarados: Administrador,Gerente,Supervisor.
Ambiente de teste de agentes — AgentesSandbox
POST /api/sandbox/upload
query arquivo: IFormFile.
Retorno declarado: Task<IActionResult>. Acesso: Bearer; permissões do usuário e do módulo.
Transporte: multipart/form-data — campo de arquivo arquivo.
GET /api/sandbox/copilotos
Sem parâmetros de cliente declarados na assinatura; confira transportes especiais na operação..
Retorno declarado: Task<IActionResult>. Acesso: Bearer; permissões do usuário e do módulo.
POST /api/sandbox/copilotos/{id}/conversar
path id: long; body body: SandboxConversarInternoInputDTO — SandboxConversarInternoInputDTO.
Retorno declarado: Task<IActionResult>. Acesso: Bearer; permissões do usuário e do módulo.
GET /api/sandbox/conversacionais
Sem parâmetros de cliente declarados na assinatura; confira transportes especiais na operação..
Retorno declarado: Task<IActionResult>. Acesso: Bearer; permissões do usuário e do módulo.
POST /api/sandbox/conversacionais/{id}/conversar
path id: long; body body: SandboxConversarInputDTO — SandboxConversarInputDTO.
Retorno declarado: Task<IActionResult>. Acesso: Bearer; permissões do usuário e do módulo.
Cadências de follow-up — FollowUp
GET /api/configuracoes/FollowUp/cadencias
query agenteConversacionalId: long?.
Retorno declarado: Task<IActionResult>. Acesso: Bearer; perfis declarados: Administrador.
GET /api/configuracoes/FollowUp/cadencias/{id}
path id: long.
Retorno declarado: Task<IActionResult>. Acesso: Bearer; perfis declarados: Administrador.
POST /api/configuracoes/FollowUp/cadencias
body body: FollowUpCadenciaInputDTO — FollowUpCadenciaInputDTO.
Retorno declarado: Task<IActionResult>. Acesso: Bearer; perfis declarados: Administrador.
PUT /api/configuracoes/FollowUp/cadencias/{id}
path id: long; body body: FollowUpCadenciaInputDTO — FollowUpCadenciaInputDTO.
Retorno declarado: Task<IActionResult>. Acesso: Bearer; perfis declarados: Administrador.
DELETE /api/configuracoes/FollowUp/cadencias/{id}
path id: long.
Retorno declarado: Task<IActionResult>. Acesso: Bearer; perfis declarados: Administrador.
POST /api/configuracoes/FollowUp/cadencias/{id}/habilitar
path id: long; query habilitado: bool.
Retorno declarado: Task<IActionResult>. Acesso: Bearer; perfis declarados: Administrador.
POST /api/configuracoes/FollowUp/iniciar
body body: FollowUpIniciarInputDTO — FollowUpIniciarInputDTO.
Retorno declarado: Task<IActionResult>. Acesso: Bearer; perfis declarados: Administrador.
POST /api/configuracoes/FollowUp/iniciar-lote
body body: FollowUpIniciarLoteInputDTO — FollowUpIniciarLoteInputDTO.
Retorno declarado: Task<IActionResult>. Acesso: Bearer; perfis declarados: Administrador.
GET /api/configuracoes/FollowUp/execucoes
query cadenciaId: long?; query agenteConversacionalId: long?; query status: FollowUpStatusEnum?; query apenasAtivas: bool.
Retorno declarado: Task<IActionResult>. Acesso: Bearer; perfis declarados: Administrador.
POST /api/configuracoes/FollowUp/execucoes/{id}/cancelar
path id: long.
Retorno declarado: Task<IActionResult>. Acesso: Bearer; perfis declarados: Administrador.
POST /api/configuracoes/FollowUp/execucoes/{id}/reagendar
path id: long.
Retorno declarado: Task<IActionResult>. Acesso: Bearer; perfis declarados: Administrador.
POST /api/configuracoes/FollowUp/execucoes/reagendar-atrasadas
query cadenciaId: long?.
Retorno declarado: Task<IActionResult>. Acesso: Bearer; perfis declarados: Administrador.
Veja também
Atualizado em: 14/10/2026
Obrigado!
