Flows
Flujos de conversación
GET/api/flows
Listar los flujos de un agente de IA
Ámbito requerido: flows.read
| Parámetro | Dónde | Obligatorio |
|---|---|---|
aiAgentId | query | sí |
bash
curl "https://api.zapyflow.com.br/api/flows?aiAgentId=..." \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Respuestas
200— OK
POST/api/flows
Crear un flujo de conversación
Ámbito requerido: flows.write
Cuerpo de la petición
| Campo | Tipo | Obligatorio | Restricciones |
|---|---|---|---|
aiAgentId | string | sí | min 1 |
name | string | sí | min 1, max 100 |
trigger | object | sí | — |
steps | object[] | sí | ≥ 1 items, ≤ 100 items |
bash
curl -X POST "https://api.zapyflow.com.br/api/flows" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY" \
-H "Content-Type: application/json" \
-d '{ ... }'Respuestas
201— Creado400— Petición malformada
GET/api/flows/{id}
Detalles de un flujo
Ámbito requerido: flows.read
| Parámetro | Dónde | Obligatorio |
|---|---|---|
id | path | sí |
bash
curl "https://api.zapyflow.com.br/api/flows/{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/flows/{id}
Actualizar un flujo
Ámbito requerido: flows.write
| Parámetro | Dónde | Obligatorio |
|---|---|---|
id | path | sí |
Cuerpo de la petición
| Campo | Tipo | Obligatorio | Restricciones |
|---|---|---|---|
name | string | no | min 1, max 100 |
trigger | object | no | — |
steps | object[] | no | ≥ 1 items, ≤ 100 items |
active | boolean | no | — |
status | "DRAFT" | "ACTIVE" | "ATTENTION" | "ARCHIVED" | no | — |
bash
curl -X PATCH "https://api.zapyflow.com.br/api/flows/{id}" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY" \
-H "Content-Type: application/json" \
-d '{ ... }'Respuestas
200— OK400— Petición malformada404— No encontrado — también es la respuesta cuando el recurso es de otro workspace412
DELETE/api/flows/{id}
Eliminar un flujo
Ámbito requerido: flows.delete
| Parámetro | Dónde | Obligatorio |
|---|---|---|
id | path | sí |
bash
curl -X DELETE "https://api.zapyflow.com.br/api/flows/{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/flows/{id}/toggle
Activar o desactivar un flujo
Ámbito requerido: flows.publish
| Parámetro | Dónde | Obligatorio |
|---|---|---|
id | path | sí |
bash
curl -X PATCH "https://api.zapyflow.com.br/api/flows/{id}/toggle" \
-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
GET/api/flows/overview
KPI de flujos (7 días) y ejecuciones por agente
Ámbito requerido: flows.read
| Parámetro | Dónde | Obligatorio |
|---|---|---|
aiAgentId | query | sí |
bash
curl "https://api.zapyflow.com.br/api/flows/overview?aiAgentId=..." \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Respuestas
200— OK404— No encontrado — también es la respuesta cuando el recurso es de otro workspace