ZapyFlow/Documentação da APIopenapi.json

Flows

Fluxos de conversa

GET/api/flows

Listar fluxos de um agente de IA

Escopo exigido: flows.read

ParâmetroOndeObrigatório
aiAgentIdquerysim
bash
curl "https://api.zapyflow.com.br/api/flows?aiAgentId=..." \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"
Respostas
  • 200 — OK

POST/api/flows

Criar novo fluxo de conversa

Escopo exigido: flows.write

Corpo da requisição

CampoTipoObrigatórioRestrições
aiAgentIdstringsimmin 1
namestringsimmin 1, max 100
triggerobjectsim—
stepsobject[]sim≥ 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 '{ ... }'
Respostas
  • 201 — Criado
  • 400 — Requisição malformada

GET/api/flows/{id}

Detalhes de um fluxo

Escopo exigido: flows.read

ParâmetroOndeObrigatório
idpathsim
bash
curl "https://api.zapyflow.com.br/api/flows/{id}" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"
Respostas
  • 200 — OK
  • 404 — Não encontrado — também é a resposta quando o recurso é de outro workspace

PATCH/api/flows/{id}

Atualizar fluxo

Escopo exigido: flows.write

ParâmetroOndeObrigatório
idpathsim

Corpo da requisição

CampoTipoObrigatórioRestrições
namestringnãomin 1, max 100
triggerobjectnão—
stepsobject[]não≥ 1 items, ≤ 100 items
activebooleannão—
status"DRAFT" | "ACTIVE" | "ATTENTION" | "ARCHIVED"não—
bash
curl -X PATCH "https://api.zapyflow.com.br/api/flows/{id}" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ ... }'
Respostas
  • 200 — OK
  • 400 — Requisição malformada
  • 404 — Não encontrado — também é a resposta quando o recurso é de outro workspace
  • 412

DELETE/api/flows/{id}

Deletar fluxo

Escopo exigido: flows.delete

ParâmetroOndeObrigatório
idpathsim
bash
curl -X DELETE "https://api.zapyflow.com.br/api/flows/{id}" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"
Respostas
  • 200 — OK
  • 404 — Não encontrado — também é a resposta quando o recurso é de outro workspace

PATCH/api/flows/{id}/toggle

Ativar/desativar fluxo

Escopo exigido: flows.publish

ParâmetroOndeObrigatório
idpathsim
bash
curl -X PATCH "https://api.zapyflow.com.br/api/flows/{id}/toggle" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"
Respostas
  • 200 — OK
  • 400 — Requisição malformada
  • 404 — Não encontrado — também é a resposta quando o recurso é de outro workspace

GET/api/flows/overview

KPIs de fluxos (7 dias) + execuções por agente de IA

Escopo exigido: flows.read

ParâmetroOndeObrigatório
aiAgentIdquerysim
bash
curl "https://api.zapyflow.com.br/api/flows/overview?aiAgentId=..." \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"
Respostas
  • 200 — OK
  • 404 — Não encontrado — também é a resposta quando o recurso é de outro workspace