AI Agents
Agentes de IA: configuración, publicación, pruebas
GET/api/ai-agents
Ámbito requerido: agents.read
| Parámetro | Dónde | Obligatorio |
|---|---|---|
search | query | no |
archived | query | no |
bash
curl "https://api.zapyflow.com.br/api/ai-agents" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Respuestas
200— OK
POST/api/ai-agents
Ámbito requerido: agents.write
Cuerpo de la petición
| Campo | Tipo | Obligatorio | Restricciones |
|---|---|---|---|
name | string | sí | min 2, max 120 |
agentType | "STANDARD" | "EXPERT" | no | — |
description | string | no | max 2000 |
language | "pt" | "en" | "es" | no | — |
tone | string | no | max 4000 |
greetingMessage | string | no | max 4000 |
fallbackMessage | string | no | max 4000 |
outOfHoursMessage | string | no | max 4000 |
businessHours | object | no | — |
services | object[] | no | — |
rules | object | no | — |
behavior | object | no | — |
functionKey | string | no | min 1, max 80 |
faqs | object[] | no | ≤ 200 items |
templateId | string | no | 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 '{ ... }'Respuestas
201— Creado403— Prohibido, o la clave no tiene este ámbito
GET/api/ai-agents/{id}
Ámbito requerido: agents.read
| Parámetro | Dónde | Obligatorio |
|---|---|---|
id | path | sí |
bash
curl "https://api.zapyflow.com.br/api/ai-agents/{id}" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Respuestas
200— OK404— No encontrado — también es la respuesta cuando el recurso es de otro workspace
PATCH/api/ai-agents/{id}
Ámbito requerido: agents.write
| Parámetro | Dónde | Obligatorio |
|---|---|---|
id | path | sí |
Cuerpo de la petición
| Campo | Tipo | Obligatorio | Restricciones |
|---|---|---|---|
name | string | no | min 2, max 120 |
agentType | "STANDARD" | "EXPERT" | no | — |
description | string | null | no | — |
language | "pt" | "en" | "es" | no | — |
tone | string | null | no | — |
greetingMessage | string | null | no | — |
fallbackMessage | string | null | no | — |
outOfHoursMessage | string | null | no | — |
businessHours | object | null | no | — |
services | object[] | null | no | — |
rules | object | null | no | — |
behavior | object | null | no | — |
functionKey | string | null | no | — |
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 '{ ... }'Respuestas
200— OK412
DELETE/api/ai-agents/{id}
Eliminar un agente que no tiene datos de negocio
Ámbito requerido: agents.lifecycle
| Parámetro | Dónde | Obligatorio |
|---|---|---|
id | path | sí |
bash
curl -X DELETE "https://api.zapyflow.com.br/api/ai-agents/{id}" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Respuestas
200— OK404— No encontrado — también es la respuesta cuando el recurso es de otro workspace409— Conflicto con el estado actual
POST/api/ai-agents/{id}/archive
Archiva el agente: sale de la lista, deja de atender, nada se pierde
Ámbito requerido: agents.lifecycle
| Parámetro | Dónde | Obligatorio |
|---|---|---|
id | path | sí |
bash
curl -X POST "https://api.zapyflow.com.br/api/ai-agents/{id}/archive" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Respuestas
200— OK404— No encontrado — también es la respuesta cuando el recurso es de otro workspace409— Conflicto con el estado actual
GET/api/ai-agents/{id}/channel-flow-options
Ámbito requerido: agents.read
| Parámetro | Dónde | Obligatorio |
|---|---|---|
id | path | sí |
bash
curl "https://api.zapyflow.com.br/api/ai-agents/{id}/channel-flow-options" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Respuestas
200— OK
GET/api/ai-agents/{id}/channel-template-options
Ámbito requerido: agents.read
| Parámetro | Dónde | Obligatorio |
|---|---|---|
category | query | no |
id | path | sí |
bash
curl "https://api.zapyflow.com.br/api/ai-agents/{id}/channel-template-options" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Respuestas
200— OK
GET/api/ai-agents/{id}/deletion-impact
Qué se destruiría al eliminar el agente
Ámbito requerido: agents.read
| Parámetro | Dónde | Obligatorio |
|---|---|---|
id | path | sí |
bash
curl "https://api.zapyflow.com.br/api/ai-agents/{id}/deletion-impact" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Respuestas
200— OK404— No encontrado — también es la respuesta cuando el recurso es de otro workspace
GET/api/ai-agents/{id}/eval
Último resultado de la batería de frontera y el estado de la puerta
Ámbito requerido: agents.read
| Parámetro | Dónde | Obligatorio |
|---|---|---|
id | path | sí |
bash
curl "https://api.zapyflow.com.br/api/ai-agents/{id}/eval" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Respuestas
200— OK404— No encontrado — también es la respuesta cuando el recurso es de otro workspace
POST/api/ai-agents/{id}/publish
Ámbito requerido: agents.lifecycle
| Parámetro | Dónde | Obligatorio |
|---|---|---|
id | path | sí |
bash
curl -X POST "https://api.zapyflow.com.br/api/ai-agents/{id}/publish" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Respuestas
200— OK409— Conflicto con el estado actual
DELETE/api/ai-agents/{id}/reassign/{targetId}
Mueve conversaciones, leads, citas y pedidos a otro agente y elimina este
Ámbito requerido: agents.lifecycle
| Parámetro | Dónde | Obligatorio |
|---|---|---|
id | path | sí |
targetId | path | sí |
bash
curl -X DELETE "https://api.zapyflow.com.br/api/ai-agents/{id}/reassign/{targetId}" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Respuestas
200— OK400— Petición malformada404— No encontrado — también es la respuesta cuando el recurso es de otro workspace409— Conflicto con el estado actual
GET/api/ai-agents/{id}/rules
Las reglas de atención del agente, direccionables
Ámbito requerido: agents.read
| Parámetro | Dónde | Obligatorio |
|---|---|---|
id | path | sí |
bash
curl "https://api.zapyflow.com.br/api/ai-agents/{id}/rules" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Respuestas
200— OK404— No encontrado — también es la respuesta cuando el recurso es de otro workspace
PATCH/api/ai-agents/{id}/rules
Cambia, elimina o añade una regla sin reescribir las demás
Ámbito requerido: agents.write
| Parámetro | Dónde | Obligatorio |
|---|---|---|
id | path | sí |
bash
curl -X PATCH "https://api.zapyflow.com.br/api/ai-agents/{id}/rules" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Respuestas
200— OK400— Petición malformada404— No encontrado — también es la respuesta cuando el recurso es de otro workspace
POST/api/ai-agents/{id}/unarchive
Saca el agente del archivo. Vuelve como borrador.
Ámbito requerido: agents.lifecycle
| Parámetro | Dónde | Obligatorio |
|---|---|---|
id | path | sí |
bash
curl -X POST "https://api.zapyflow.com.br/api/ai-agents/{id}/unarchive" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Respuestas
200— OK404— No encontrado — también es la respuesta cuando el recurso es de otro workspace409— Conflicto con el estado actual
POST/api/ai-agents/{id}/unpublish
Ámbito requerido: agents.lifecycle
| Parámetro | Dónde | Obligatorio |
|---|---|---|
id | path | sí |
bash
curl -X POST "https://api.zapyflow.com.br/api/ai-agents/{id}/unpublish" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Respuestas
200— OK409— Conflicto con el estado actual
GET/api/ai-agents/functions
Catálogo de sectores y funciones de agente
Ámbito requerido: agents.read
bash
curl "https://api.zapyflow.com.br/api/ai-agents/functions" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Respuestas
200— OK
GET/api/ai-agents/overview
KPI del equipo (7 días) y métricas por agente de IA
Ámbito requerido: agents.read
bash
curl "https://api.zapyflow.com.br/api/ai-agents/overview" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Respuestas
200— OK
GET/api/ai-agents/voice-catalog
Catálogo de voces, modelos y ajustes de naturalidad
Ámbito requerido: agents.read
bash
curl "https://api.zapyflow.com.br/api/ai-agents/voice-catalog" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Respuestas
200— OK