AI Agents
Agentes de IA: configuracao, publicacao, testes
GET/api/ai-agents
Escopo exigido: agents.read
| Parâmetro | Onde | Obrigatório |
|---|---|---|
search | query | não |
archived | query | não |
bash
curl "https://api.zapyflow.com.br/api/ai-agents" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Respostas
200— OK
POST/api/ai-agents
Escopo exigido: agents.write
Corpo da requisição
| Campo | Tipo | Obrigatório | Restrições |
|---|---|---|---|
name | string | sim | min 2, max 120 |
agentType | "STANDARD" | "EXPERT" | não | — |
description | string | não | max 2000 |
language | "pt" | "en" | "es" | não | — |
tone | string | não | max 4000 |
greetingMessage | string | não | max 4000 |
fallbackMessage | string | não | max 4000 |
outOfHoursMessage | string | não | max 4000 |
businessHours | object | não | — |
services | object[] | não | — |
rules | object | não | — |
behavior | object | não | — |
functionKey | string | não | min 1, max 80 |
faqs | object[] | não | ≤ 200 items |
templateId | string | não | min 1 |
bash
curl -X POST "https://api.zapyflow.com.br/api/ai-agents" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY" \
-H "Content-Type: application/json" \
-d '{ ... }'Respostas
201— Criado403— Proibido, ou a chave não tem este escopo
GET/api/ai-agents/{id}
Escopo exigido: agents.read
| Parâmetro | Onde | Obrigatório |
|---|---|---|
id | path | sim |
bash
curl "https://api.zapyflow.com.br/api/ai-agents/{id}" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Respostas
200— OK404— Não encontrado — também é a resposta quando o recurso é de outro workspace
PATCH/api/ai-agents/{id}
Escopo exigido: agents.write
| Parâmetro | Onde | Obrigatório |
|---|---|---|
id | path | sim |
Corpo da requisição
| Campo | Tipo | Obrigatório | Restrições |
|---|---|---|---|
name | string | não | min 2, max 120 |
agentType | "STANDARD" | "EXPERT" | não | — |
description | string | null | não | — |
language | "pt" | "en" | "es" | não | — |
tone | string | null | não | — |
greetingMessage | string | null | não | — |
fallbackMessage | string | null | não | — |
outOfHoursMessage | string | null | não | — |
businessHours | object | null | não | — |
services | object[] | null | não | — |
rules | object | null | não | — |
behavior | object | null | não | — |
functionKey | string | null | não | — |
bash
curl -X PATCH "https://api.zapyflow.com.br/api/ai-agents/{id}" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY" \
-H "Content-Type: application/json" \
-d '{ ... }'Respostas
200— OK412
DELETE/api/ai-agents/{id}
Excluir um agente que não tem dado de negócio
Escopo exigido: agents.lifecycle
| Parâmetro | Onde | Obrigatório |
|---|---|---|
id | path | sim |
bash
curl -X DELETE "https://api.zapyflow.com.br/api/ai-agents/{id}" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Respostas
200— OK404— Não encontrado — também é a resposta quando o recurso é de outro workspace409— Conflito com o estado atual
POST/api/ai-agents/{id}/archive
Arquiva o agente: sai da lista, para de atender, nada é perdido
Escopo exigido: agents.lifecycle
| Parâmetro | Onde | Obrigatório |
|---|---|---|
id | path | sim |
bash
curl -X POST "https://api.zapyflow.com.br/api/ai-agents/{id}/archive" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Respostas
200— OK404— Não encontrado — também é a resposta quando o recurso é de outro workspace409— Conflito com o estado atual
GET/api/ai-agents/{id}/channel-flow-options
Escopo exigido: agents.read
| Parâmetro | Onde | Obrigatório |
|---|---|---|
id | path | sim |
bash
curl "https://api.zapyflow.com.br/api/ai-agents/{id}/channel-flow-options" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Respostas
200— OK
GET/api/ai-agents/{id}/channel-template-options
Escopo exigido: agents.read
| Parâmetro | Onde | Obrigatório |
|---|---|---|
category | query | não |
id | path | sim |
bash
curl "https://api.zapyflow.com.br/api/ai-agents/{id}/channel-template-options" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Respostas
200— OK
GET/api/ai-agents/{id}/deletion-impact
O que seria destruído ao excluir o agente
Escopo exigido: agents.read
| Parâmetro | Onde | Obrigatório |
|---|---|---|
id | path | sim |
bash
curl "https://api.zapyflow.com.br/api/ai-agents/{id}/deletion-impact" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Respostas
200— OK404— Não encontrado — também é a resposta quando o recurso é de outro workspace
GET/api/ai-agents/{id}/eval
Último resultado da bateria de fronteira e o estado do portão
Escopo exigido: agents.read
| Parâmetro | Onde | Obrigatório |
|---|---|---|
id | path | sim |
bash
curl "https://api.zapyflow.com.br/api/ai-agents/{id}/eval" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Respostas
200— OK404— Não encontrado — também é a resposta quando o recurso é de outro workspace
POST/api/ai-agents/{id}/publish
Escopo exigido: agents.lifecycle
| Parâmetro | Onde | Obrigatório |
|---|---|---|
id | path | sim |
bash
curl -X POST "https://api.zapyflow.com.br/api/ai-agents/{id}/publish" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Respostas
200— OK409— Conflito com o estado atual
DELETE/api/ai-agents/{id}/reassign/{targetId}
Move conversas, leads, agendamentos e pedidos para outro agente e exclui este
Escopo exigido: agents.lifecycle
| Parâmetro | Onde | Obrigatório |
|---|---|---|
id | path | sim |
targetId | path | sim |
bash
curl -X DELETE "https://api.zapyflow.com.br/api/ai-agents/{id}/reassign/{targetId}" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Respostas
200— OK400— Requisição malformada404— Não encontrado — também é a resposta quando o recurso é de outro workspace409— Conflito com o estado atual
GET/api/ai-agents/{id}/rules
As regras de atendimento do agente, endereçáveis
Escopo exigido: agents.read
| Parâmetro | Onde | Obrigatório |
|---|---|---|
id | path | sim |
bash
curl "https://api.zapyflow.com.br/api/ai-agents/{id}/rules" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Respostas
200— OK404— Não encontrado — também é a resposta quando o recurso é de outro workspace
PATCH/api/ai-agents/{id}/rules
Altera, remove ou acrescenta uma regra sem reescrever as outras
Escopo exigido: agents.write
| Parâmetro | Onde | Obrigatório |
|---|---|---|
id | path | sim |
bash
curl -X PATCH "https://api.zapyflow.com.br/api/ai-agents/{id}/rules" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Respostas
200— OK400— Requisição malformada404— Não encontrado — também é a resposta quando o recurso é de outro workspace
POST/api/ai-agents/{id}/unarchive
Tira o agente do arquivo. Ele volta como rascunho.
Escopo exigido: agents.lifecycle
| Parâmetro | Onde | Obrigatório |
|---|---|---|
id | path | sim |
bash
curl -X POST "https://api.zapyflow.com.br/api/ai-agents/{id}/unarchive" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Respostas
200— OK404— Não encontrado — também é a resposta quando o recurso é de outro workspace409— Conflito com o estado atual
POST/api/ai-agents/{id}/unpublish
Escopo exigido: agents.lifecycle
| Parâmetro | Onde | Obrigatório |
|---|---|---|
id | path | sim |
bash
curl -X POST "https://api.zapyflow.com.br/api/ai-agents/{id}/unpublish" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Respostas
200— OK409— Conflito com o estado atual
GET/api/ai-agents/functions
Catálogo de setores e funções de agente
Escopo exigido: agents.read
bash
curl "https://api.zapyflow.com.br/api/ai-agents/functions" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Respostas
200— OK
GET/api/ai-agents/overview
KPIs da equipe (7 dias) e metricas por agente de IA
Escopo exigido: agents.read
bash
curl "https://api.zapyflow.com.br/api/ai-agents/overview" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Respostas
200— OK
GET/api/ai-agents/voice-catalog
Catálogo de vozes, modelos e presets de naturalidade
Escopo exigido: agents.read
bash
curl "https://api.zapyflow.com.br/api/ai-agents/voice-catalog" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Respostas
200— OK