> ## Knowledge Base Index
> Fetch the complete knowledge base index at: https://ajuda.groner.app/sitemap.xml
> Use this file to discover available pages before exploring further.
> Pure-Markdown content can be obtained by appending a '.md' suffix to the content URLs listed in the sitemap (without the trailing slash).

# 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](https://ajuda.groner.app/pt-br/article/documentacao-da-api-groner-crm-vz2bq2/) · [Exemplos](#2-exemplos-de-requisicao-e-resposta) · [Endpoints](#2-referencia-dos-endpoints)

|| Revisão: **14/10/2026**. Classificação conferida nos clients dos produtos e nas rotas registradas do servidor. Respostas abaixo são exemplos completos do contrato escolhido com dados fictícios, não capturas de produção.

## Índice clicável

[Configuração de agentes conversacionais — AgenteConversacional](#3-configuracao-de-agentes-conversacionais-agenteconversacional) · [Catálogo de ações — AgenteAcaoCatalogo](#3-catalogo-de-acoes-agenteacaocatalogo) · [Conhecimento dos agentes — AgenteConhecimento](#3-conhecimento-dos-agentes-agenteconhecimento) · [Logs de execução — AgenteExecucaoLog](#3-logs-de-execucao-agenteexecucaolog) · [Tarefas elegíveis para IA — AgenteTarefas](#3-tarefas-elegiveis-para-ia-agentetarefas) · [Agente de perguntas e respostas — AgenteQnaConfig](#3-agente-de-perguntas-e-respostas-agenteqnaconfig) · [Feedback de respostas — AgenteRespostaFeedback](#3-feedback-de-respostas-agenterespostafeedback) · [Configuração de agentes de tarefa — TipoTarefaAgenteConfig](#3-configuracao-de-agentes-de-tarefa-tipotarefaagenteconfig) · [Ações HTTP customizadas — AcaoCustomizada](#3-acoes-http-customizadas-acaocustomizada) · [Configuração de copilotos — AgenteInterno](#3-configuracao-de-copilotos-agenteinterno) · [Métricas e sessões de copilotos — Copiloto](#3-metricas-e-sessoes-de-copilotos-copiloto) · [Métricas e sessões conversacionais — ConversacionalDashboard](#3-metricas-e-sessoes-conversacionais-conversacionaldashboard) · [Ambiente de teste de agentes — AgentesSandbox](#3-ambiente-de-teste-de-agentes-agentessandbox) · [Cadências de follow-up — FollowUp](#3-cadencias-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):**

```bash
curl --request GET \
  --url "$API_URL/api/configuracoes/AgenteConversacional" \
  --header "Authorization: Bearer $TOKEN" \
  --header "Accept: application/json"
```

**Resposta ilustrativa — HTTP 200:**

```json
{
  "Version": "1.0.0.0",
  "StatusCode": 200,
  "Message": "Requisição efetuada com suceesso.",
  "Content": []
}
```

### Pausar um agente autorizado

**Requisição completa (Bash):**

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

[Voltar ao índice](#2-indice-clicavel)

#### `GET /api/configuracoes/AgenteConversacional/{id}`

**path** `id`: `long`.

**Retorno declarado:** `Task<IActionResult>`. **Acesso:** Bearer; perfis declarados: Administrador.

[Voltar ao índice](#2-indice-clicavel)

#### `DELETE /api/configuracoes/AgenteConversacional/{id}`

**path** `id`: `long`.

**Retorno declarado:** `Task<IActionResult>`. **Acesso:** Bearer; perfis declarados: Administrador.

[Voltar ao índice](#2-indice-clicavel)

#### `POST /api/configuracoes/AgenteConversacional`

**body** `body`: `AgenteConversacionalInputDTO` — [AgenteConversacionalInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-01-12uez99/#3-agenteconversacionalinputdto).

**Retorno declarado:** `Task<IActionResult>`. **Acesso:** Bearer; perfis declarados: Administrador.

[Voltar ao índice](#2-indice-clicavel)

#### `PUT /api/configuracoes/AgenteConversacional/{id}`

**path** `id`: `long`; **body** `body`: `AgenteConversacionalInputDTO` — [AgenteConversacionalInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-01-12uez99/#3-agenteconversacionalinputdto).

**Retorno declarado:** `Task<IActionResult>`. **Acesso:** Bearer; perfis declarados: Administrador.

[Voltar ao índice](#2-indice-clicavel)

#### `POST /api/configuracoes/AgenteConversacional/{id}/ativar`

**path** `id`: `long`.

**Retorno declarado:** `Task<IActionResult>`. **Acesso:** Bearer; perfis declarados: Administrador.

[Voltar ao índice](#2-indice-clicavel)

#### `POST /api/configuracoes/AgenteConversacional/{id}/pausar`

**path** `id`: `long`.

**Retorno declarado:** `Task<IActionResult>`. **Acesso:** Bearer; perfis declarados: Administrador.

[Voltar ao índice](#2-indice-clicavel)

#### `POST /api/configuracoes/AgenteConversacional/{id}/canais`

**path** `id`: `long`; **body** `body`: `AgenteConversacionalCanalInputDTO` — [AgenteConversacionalCanalInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-01-12uez99/#3-agenteconversacionalcanalinputdto).

**Retorno declarado:** `Task<IActionResult>`. **Acesso:** Bearer; perfis declarados: Administrador.

[Voltar ao índice](#2-indice-clicavel)

#### `DELETE /api/configuracoes/AgenteConversacional/canais/{canalId}`

**path** `canalId`: `long`.

**Retorno declarado:** `Task<IActionResult>`. **Acesso:** Bearer; perfis declarados: Administrador.

[Voltar ao índice](#2-indice-clicavel)

#### `GET /api/configuracoes/AgenteConversacional/{id}/historico`

**path** `id`: `long`.

**Retorno declarado:** `Task<IActionResult>`. **Acesso:** Bearer; perfis declarados: Administrador.

[Voltar ao índice](#2-indice-clicavel)

#### `POST /api/configuracoes/AgenteConversacional/{id}/sandbox/conversar`

**path** `id`: `long`; **body** `body`: `SandboxConversarInputDTO` — [SandboxConversarInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-05-1euyfrd/#3-sandboxconversarinputdto).

**Retorno declarado:** `Task<IActionResult>`. **Acesso:** Bearer; perfis declarados: Administrador.

[Voltar ao índice](#2-indice-clicavel)

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

[Voltar ao índice](#2-indice-clicavel)

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

[Voltar ao índice](#2-indice-clicavel)

#### `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`.

[Voltar ao índice](#2-indice-clicavel)

#### `GET /api/configuracoes/AgenteConversacional/{agenteId}/conhecimento/{arquivoId}/download`

**path** `agenteId`: `long`; **path** `arquivoId`: `long`.

**Retorno declarado:** `Task<IActionResult>`. **Acesso:** Bearer; perfis declarados: Administrador.

[Voltar ao índice](#2-indice-clicavel)

#### `DELETE /api/configuracoes/AgenteConversacional/{agenteId}/conhecimento/{arquivoId}`

**path** `agenteId`: `long`; **path** `arquivoId`: `long`.

**Retorno declarado:** `Task<IActionResult>`. **Acesso:** Bearer; perfis declarados: Administrador.

[Voltar ao índice](#2-indice-clicavel)

#### `POST /api/configuracoes/AgenteConversacional/{agenteId}/conhecimento/sincronizar`

**path** `agenteId`: `long`.

**Retorno declarado:** `Task<IActionResult>`. **Acesso:** Bearer; perfis declarados: Administrador.

[Voltar ao índice](#2-indice-clicavel)

#### `GET /api/configuracoes/AgenteConversacional/{agenteId}/conhecimento/sincronizacao/status`

**path** `agenteId`: `long`.

**Retorno declarado:** `Task<IActionResult>`. **Acesso:** Bearer; perfis declarados: Administrador.

[Voltar ao índice](#2-indice-clicavel)

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

[Voltar ao índice](#2-indice-clicavel)

#### `POST /api/configuracoes/agentes/execucoes/{id}/aprovar`

**path** `id`: `long`.

**Retorno declarado:** `Task<IActionResult>`. **Acesso:** Bearer; perfis declarados: Administrador,Gerente,Supervisor.

[Voltar ao índice](#2-indice-clicavel)

#### `POST /api/configuracoes/agentes/execucoes/{id}/rejeitar`

**path** `id`: `long`.

**Retorno declarado:** `Task<IActionResult>`. **Acesso:** Bearer; perfis declarados: Administrador,Gerente,Supervisor.

[Voltar ao índice](#2-indice-clicavel)

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

[Voltar ao índice](#2-indice-clicavel)

#### `GET /api/configuracoes/agentes/tarefas/{id}`

**path** `id`: `long`.

**Retorno declarado:** `Task<IActionResult>`. **Acesso:** Bearer; perfis declarados: Administrador,Gerente,Supervisor.

[Voltar ao índice](#2-indice-clicavel)

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

[Voltar ao índice](#2-indice-clicavel)

#### `PUT /api/configuracoes/agentes/qna`

**body** `body`: `AgenteQnaConfig` — [AgenteQnaConfig](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-01-12uez99/#3-agenteqnaconfig).

**Retorno declarado:** `Task<IActionResult>`. **Acesso:** Bearer; perfis declarados: Administrador.

[Voltar ao índice](#2-indice-clicavel)

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

[Voltar ao índice](#2-indice-clicavel)

#### `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](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-05-1euyfrd/#3-respostafeedbackinputdto).

**Retorno declarado:** `Task<IActionResult>`. **Acesso:** Bearer; perfis declarados: Administrador,Gerente,Supervisor.

[Voltar ao índice](#2-indice-clicavel)

#### `DELETE /api/configuracoes/agentes/conversacional/feedback/{id}`

**path** `id`: `long`.

**Retorno declarado:** `Task<IActionResult>`. **Acesso:** Bearer; perfis declarados: Administrador,Gerente,Supervisor.

[Voltar ao índice](#2-indice-clicavel)

#### `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.

[Voltar ao índice](#2-indice-clicavel)

#### `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.

[Voltar ao índice](#2-indice-clicavel)

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

[Voltar ao índice](#2-indice-clicavel)

#### `GET /api/configuracoes/TipoTarefaAgenteConfig/{tipoTarefaId}`

**path** `tipoTarefaId`: `long`.

**Retorno declarado:** `Task<IActionResult>`. **Acesso:** Bearer; perfis declarados: Administrador.

[Voltar ao índice](#2-indice-clicavel)

#### `POST /api/configuracoes/TipoTarefaAgenteConfig`

**body** `body`: `TipoTarefaAgenteConfig` — [TipoTarefaAgenteConfig](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-06-16y2x3u/#3-tipotarefaagenteconfig).

**Retorno declarado:** `Task<IActionResult>`. **Acesso:** Bearer; perfis declarados: Administrador.

[Voltar ao índice](#2-indice-clicavel)

#### `PUT /api/configuracoes/TipoTarefaAgenteConfig/{id}`

**path** `id`: `long`; **body** `body`: `TipoTarefaAgenteConfig` — [TipoTarefaAgenteConfig](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-06-16y2x3u/#3-tipotarefaagenteconfig).

**Retorno declarado:** `Task<IActionResult>`. **Acesso:** Bearer; perfis declarados: Administrador.

[Voltar ao índice](#2-indice-clicavel)

#### `GET /api/configuracoes/TipoTarefaAgenteConfig/{id}/historico`

**path** `id`: `long`.

**Retorno declarado:** `Task<IActionResult>`. **Acesso:** Bearer; perfis declarados: Administrador.

[Voltar ao índice](#2-indice-clicavel)

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

[Voltar ao índice](#2-indice-clicavel)

#### `GET /api/configuracoes/agentes/acoes-customizadas/{id}`

**path** `id`: `long`.

**Retorno declarado:** `Task<ActionResult<AcaoCustomizadaOutputDTO>>`. **Acesso:** Bearer; perfis declarados: Administrador.

[Voltar ao índice](#2-indice-clicavel)

#### `POST /api/configuracoes/agentes/acoes-customizadas`

**body** `body`: `AcaoCustomizadaInputDTO` — [AcaoCustomizadaInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-01-12uez99/#3-acaocustomizadainputdto).

**Retorno declarado:** `Task<ActionResult<AcaoCustomizadaOutputDTO>>`. **Acesso:** Bearer; perfis declarados: Administrador.

[Voltar ao índice](#2-indice-clicavel)

#### `PUT /api/configuracoes/agentes/acoes-customizadas/{id}`

**path** `id`: `long`; **body** `body`: `AcaoCustomizadaInputDTO` — [AcaoCustomizadaInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-01-12uez99/#3-acaocustomizadainputdto).

**Retorno declarado:** `Task<ActionResult<AcaoCustomizadaOutputDTO>>`. **Acesso:** Bearer; perfis declarados: Administrador.

[Voltar ao índice](#2-indice-clicavel)

#### `DELETE /api/configuracoes/agentes/acoes-customizadas/{id}`

**path** `id`: `long`.

**Retorno declarado:** `Task<IActionResult>`. **Acesso:** Bearer; perfis declarados: Administrador.

[Voltar ao índice](#2-indice-clicavel)

#### `POST /api/configuracoes/agentes/acoes-customizadas/testar`

**body** `body`: `AcaoCustomizadaTestarInputDTO` — [AcaoCustomizadaTestarInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-01-12uez99/#3-acaocustomizadatestarinputdto).

**Retorno declarado:** `Task<ActionResult<AcaoCustomizadaTestarOutputDTO>>`. **Acesso:** Bearer; perfis declarados: Administrador.

[Voltar ao índice](#2-indice-clicavel)

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

[Voltar ao índice](#2-indice-clicavel)

#### `GET /api/configuracoes/AgenteInterno/{id}`

**path** `id`: `long`.

**Retorno declarado:** `Task<IActionResult>`. **Acesso:** Bearer; perfis declarados: Administrador.

[Voltar ao índice](#2-indice-clicavel)

#### `POST /api/configuracoes/AgenteInterno`

**body** `body`: `AgenteInternoInputDTO` — [AgenteInternoInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-01-12uez99/#3-agenteinternoinputdto).

**Retorno declarado:** `Task<IActionResult>`. **Acesso:** Bearer; perfis declarados: Administrador.

[Voltar ao índice](#2-indice-clicavel)

#### `PUT /api/configuracoes/AgenteInterno/{id}`

**path** `id`: `long`; **body** `body`: `AgenteInternoInputDTO` — [AgenteInternoInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-01-12uez99/#3-agenteinternoinputdto).

**Retorno declarado:** `Task<IActionResult>`. **Acesso:** Bearer; perfis declarados: Administrador.

[Voltar ao índice](#2-indice-clicavel)

#### `POST /api/configuracoes/AgenteInterno/{id}/ativar`

**path** `id`: `long`.

**Retorno declarado:** `Task<IActionResult>`. **Acesso:** Bearer; perfis declarados: Administrador.

[Voltar ao índice](#2-indice-clicavel)

#### `POST /api/configuracoes/AgenteInterno/{id}/pausar`

**path** `id`: `long`.

**Retorno declarado:** `Task<IActionResult>`. **Acesso:** Bearer; perfis declarados: Administrador.

[Voltar ao índice](#2-indice-clicavel)

#### `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.

[Voltar ao índice](#2-indice-clicavel)

#### `POST /api/configuracoes/AgenteInterno/{id}/sandbox/conversar`

**path** `id`: `long`; **body** `body`: `SandboxConversarInternoInputDTO` — [SandboxConversarInternoInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-05-1euyfrd/#3-sandboxconversarinternoinputdto).

**Retorno declarado:** `Task<IActionResult>`. **Acesso:** Bearer; perfis declarados: Administrador.

[Voltar ao índice](#2-indice-clicavel)

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

[Voltar ao índice](#2-indice-clicavel)

#### `GET /api/configuracoes/agentes/copiloto/eval/rodadas/{id}`

**path** `id`: `long`.

**Retorno declarado:** `Task<IActionResult>`. **Acesso:** Bearer; perfis declarados: Administrador,Gerente,Supervisor.

[Voltar ao índice](#2-indice-clicavel)

#### `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.

[Voltar ao índice](#2-indice-clicavel)

#### `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.

[Voltar ao índice](#2-indice-clicavel)

#### `GET /api/configuracoes/agentes/copiloto/sessoes/{sessionId}`

**path** `sessionId`: `string`.

**Retorno declarado:** `Task<IActionResult>`. **Acesso:** Bearer; perfis declarados: Administrador,Gerente,Supervisor.

[Voltar ao índice](#2-indice-clicavel)

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

[Voltar ao índice](#2-indice-clicavel)

#### `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.

[Voltar ao índice](#2-indice-clicavel)

#### `GET /api/configuracoes/agentes/conversacional/sessoes/{sessionId}`

**path** `sessionId`: `string`.

**Retorno declarado:** `Task<IActionResult>`. **Acesso:** Bearer; perfis declarados: Administrador,Gerente,Supervisor.

[Voltar ao índice](#2-indice-clicavel)

#### `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.

[Voltar ao índice](#2-indice-clicavel)

#### `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.

[Voltar ao índice](#2-indice-clicavel)

### 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`.

[Voltar ao índice](#2-indice-clicavel)

#### `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.

[Voltar ao índice](#2-indice-clicavel)

#### `POST /api/sandbox/copilotos/{id}/conversar`

**path** `id`: `long`; **body** `body`: `SandboxConversarInternoInputDTO` — [SandboxConversarInternoInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-05-1euyfrd/#3-sandboxconversarinternoinputdto).

**Retorno declarado:** `Task<IActionResult>`. **Acesso:** Bearer; permissões do usuário e do módulo.

[Voltar ao índice](#2-indice-clicavel)

#### `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.

[Voltar ao índice](#2-indice-clicavel)

#### `POST /api/sandbox/conversacionais/{id}/conversar`

**path** `id`: `long`; **body** `body`: `SandboxConversarInputDTO` — [SandboxConversarInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-05-1euyfrd/#3-sandboxconversarinputdto).

**Retorno declarado:** `Task<IActionResult>`. **Acesso:** Bearer; permissões do usuário e do módulo.

[Voltar ao índice](#2-indice-clicavel)

### Cadências de follow-up — FollowUp

#### `GET /api/configuracoes/FollowUp/cadencias`

**query** `agenteConversacionalId`: `long?`.

**Retorno declarado:** `Task<IActionResult>`. **Acesso:** Bearer; perfis declarados: Administrador.

[Voltar ao índice](#2-indice-clicavel)

#### `GET /api/configuracoes/FollowUp/cadencias/{id}`

**path** `id`: `long`.

**Retorno declarado:** `Task<IActionResult>`. **Acesso:** Bearer; perfis declarados: Administrador.

[Voltar ao índice](#2-indice-clicavel)

#### `POST /api/configuracoes/FollowUp/cadencias`

**body** `body`: `FollowUpCadenciaInputDTO` — [FollowUpCadenciaInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-03-186hp04/#3-followupcadenciainputdto).

**Retorno declarado:** `Task<IActionResult>`. **Acesso:** Bearer; perfis declarados: Administrador.

[Voltar ao índice](#2-indice-clicavel)

#### `PUT /api/configuracoes/FollowUp/cadencias/{id}`

**path** `id`: `long`; **body** `body`: `FollowUpCadenciaInputDTO` — [FollowUpCadenciaInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-03-186hp04/#3-followupcadenciainputdto).

**Retorno declarado:** `Task<IActionResult>`. **Acesso:** Bearer; perfis declarados: Administrador.

[Voltar ao índice](#2-indice-clicavel)

#### `DELETE /api/configuracoes/FollowUp/cadencias/{id}`

**path** `id`: `long`.

**Retorno declarado:** `Task<IActionResult>`. **Acesso:** Bearer; perfis declarados: Administrador.

[Voltar ao índice](#2-indice-clicavel)

#### `POST /api/configuracoes/FollowUp/cadencias/{id}/habilitar`

**path** `id`: `long`; **query** `habilitado`: `bool`.

**Retorno declarado:** `Task<IActionResult>`. **Acesso:** Bearer; perfis declarados: Administrador.

[Voltar ao índice](#2-indice-clicavel)

#### `POST /api/configuracoes/FollowUp/iniciar`

**body** `body`: `FollowUpIniciarInputDTO` — [FollowUpIniciarInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-03-186hp04/#3-followupiniciarinputdto).

**Retorno declarado:** `Task<IActionResult>`. **Acesso:** Bearer; perfis declarados: Administrador.

[Voltar ao índice](#2-indice-clicavel)

#### `POST /api/configuracoes/FollowUp/iniciar-lote`

**body** `body`: `FollowUpIniciarLoteInputDTO` — [FollowUpIniciarLoteInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-03-186hp04/#3-followupiniciarloteinputdto).

**Retorno declarado:** `Task<IActionResult>`. **Acesso:** Bearer; perfis declarados: Administrador.

[Voltar ao índice](#2-indice-clicavel)

#### `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.

[Voltar ao índice](#2-indice-clicavel)

#### `POST /api/configuracoes/FollowUp/execucoes/{id}/cancelar`

**path** `id`: `long`.

**Retorno declarado:** `Task<IActionResult>`. **Acesso:** Bearer; perfis declarados: Administrador.

[Voltar ao índice](#2-indice-clicavel)

#### `POST /api/configuracoes/FollowUp/execucoes/{id}/reagendar`

**path** `id`: `long`.

**Retorno declarado:** `Task<IActionResult>`. **Acesso:** Bearer; perfis declarados: Administrador.

[Voltar ao índice](#2-indice-clicavel)

#### `POST /api/configuracoes/FollowUp/execucoes/reagendar-atrasadas`

**query** `cadenciaId`: `long?`.

**Retorno declarado:** `Task<IActionResult>`. **Acesso:** Bearer; perfis declarados: Administrador.

[Voltar ao índice](#2-indice-clicavel)


<!-- groner-suporte:veja-tambem:inicio -->
## Veja também

* [Guia principal, autenticação e coleção Postman](https://ajuda.groner.app/pt-br/article/documentacao-da-api-groner-crm-vz2bq2/)
* [Como gerar token de API](https://ajuda.groner.app/pt-br/article/como-gerar-um-token-de-api-para-integrar-o-groner-com-outros-sistemas-2okhj6/)
* [Limites de requisições](https://ajuda.groner.app/pt-br/article/limites-de-requisicoes-da-api-da-groner-1cwtj65/)
<!-- groner-suporte:veja-tambem:fim -->