Bots

Compatibilidade: nomes antigos de Agente de IA

POST`/api/ai-agents/{id}/apply-template`

Aplicar template ao bot (sobrescreve configuracao e FAQs)

Escopo exigido: agents.write

Parâmetro	Onde	Obrigatório
`id`	path	sim

Corpo da requisição

Campo	Tipo	Obrigatório	Restrições
`templateId`	`string`	sim	min 1

bash

curl -X POST "https://api.zapyflow.com.br/api/ai-agents/{id}/apply-template" \
  -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

GET`/api/ai-agents/{id}/catalog-items`

Lista CatalogItems do bot

Escopo exigido: catalog.read

Parâmetro	Onde	Obrigatório
`id`	path	sim

bash

curl "https://api.zapyflow.com.br/api/ai-agents/{id}/catalog-items" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"

Respostas

200 — OK
404 — Não encontrado — também é a resposta quando o recurso é de outro workspace

POST`/api/ai-agents/{id}/catalog-items`

Cria CatalogItem

Escopo exigido: catalog.write

Parâmetro	Onde	Obrigatório
`id`	path	sim

Corpo da requisição

Campo	Tipo	Obrigatório	Restrições
`name`	`string`	sim	min 1, max 150
`description`	`string`	não	max 1000
`price`	`number`	sim	≥ 0
`imageUrl`	`object \| string \| null`	não	—
`category`	`object \| string \| null`	não	—
`active`	`boolean`	não	—
`order`	`integer`	não	—

bash

curl -X POST "https://api.zapyflow.com.br/api/ai-agents/{id}/catalog-items" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

Respostas

201 — Criado
404 — Não encontrado — também é a resposta quando o recurso é de outro workspace

PATCH`/api/ai-agents/{id}/catalog-items/{itemId}`

Edita CatalogItem

Escopo exigido: catalog.write

Parâmetro	Onde	Obrigatório
`id`	path	sim
`itemId`	path	sim

Corpo da requisição

Campo	Tipo	Obrigatório	Restrições
`name`	`string`	não	min 1, max 150
`description`	`string`	não	max 1000
`price`	`number`	não	≥ 0
`imageUrl`	`object \| string \| null`	não	—
`category`	`object \| string \| null`	não	—
`active`	`boolean`	não	—
`order`	`integer`	não	—

bash

curl -X PATCH "https://api.zapyflow.com.br/api/ai-agents/{id}/catalog-items/{itemId}" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

Respostas

200 — OK
404 — Não encontrado — também é a resposta quando o recurso é de outro workspace

DELETE`/api/ai-agents/{id}/catalog-items/{itemId}`

Remove CatalogItem sem mutar o recurso externo do provedor

Escopo exigido: catalog.write

Parâmetro	Onde	Obrigatório
`id`	path	sim
`itemId`	path	sim

bash

curl -X DELETE "https://api.zapyflow.com.br/api/ai-agents/{id}/catalog-items/{itemId}" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"

Respostas

204 — CatalogItem removido com sucesso
404 — Não encontrado — também é a resposta quando o recurso é de outro workspace

POST`/api/ai-agents/{id}/faq`

Adicionar FAQ ao bot

Escopo exigido: agents.write

Parâmetro	Onde	Obrigatório
`id`	path	sim

Corpo da requisição

Campo	Tipo	Obrigatório	Restrições
`question`	`string`	sim	min 1, max 500
`answer`	`string`	sim	min 1, max 2000
`order`	`integer`	não	≥ 0

bash

curl -X POST "https://api.zapyflow.com.br/api/ai-agents/{id}/faq" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

Respostas

201 — Criado
400 — Requisição malformada

PATCH`/api/ai-agents/{id}/faq/{faqId}`

Editar FAQ do bot

Escopo exigido: agents.write

Parâmetro	Onde	Obrigatório
`id`	path	sim
`faqId`	path	sim

Corpo da requisição

Campo	Tipo	Obrigatório	Restrições
`question`	`string`	não	min 1, max 500
`answer`	`string`	não	min 1, max 2000
`order`	`integer`	não	≥ 0

bash

curl -X PATCH "https://api.zapyflow.com.br/api/ai-agents/{id}/faq/{faqId}" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

Respostas

200 — OK
404 — Não encontrado — também é a resposta quando o recurso é de outro workspace

DELETE`/api/ai-agents/{id}/faq/{faqId}`

Deletar FAQ do bot

Escopo exigido: agents.write

Parâmetro	Onde	Obrigatório
`id`	path	sim
`faqId`	path	sim

bash

curl -X DELETE "https://api.zapyflow.com.br/api/ai-agents/{id}/faq/{faqId}" \
  -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/ai-agents/{id}/faq/reorder`

Reordenar FAQs do bot

Escopo exigido: agents.write

Parâmetro	Onde	Obrigatório
`id`	path	sim

Corpo da requisição

Campo	Tipo	Obrigatório	Restrições
`orderedIds`	`string[]`	sim	≥ 1 items

bash

curl -X PATCH "https://api.zapyflow.com.br/api/ai-agents/{id}/faq/reorder" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

Respostas

200 — OK
400 — Requisição malformada

GET`/api/ai-agents/{id}/knowledge`

Lista as fontes da base de conhecimento do bot

Escopo exigido: knowledge.read

Parâmetro	Onde	Obrigatório
`id`	path	sim

bash

curl "https://api.zapyflow.com.br/api/ai-agents/{id}/knowledge" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"

Respostas

200 — OK
403 — Proibido, ou a chave não tem este escopo

PATCH`/api/ai-agents/{id}/knowledge/{sourceId}`

Liga/desliga uma fonte (sem indexar de novo)

Escopo exigido: knowledge.write

Parâmetro	Onde	Obrigatório
`id`	path	sim
`sourceId`	path	sim

Corpo da requisição

Campo	Tipo	Obrigatório	Restrições
`enabled`	`boolean`	sim	—

bash

curl -X PATCH "https://api.zapyflow.com.br/api/ai-agents/{id}/knowledge/{sourceId}" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

Respostas

200 — OK
404 — Não encontrado — também é a resposta quando o recurso é de outro workspace

DELETE`/api/ai-agents/{id}/knowledge/{sourceId}`

Remove uma fonte e seus trechos indexados

Escopo exigido: knowledge.write

Parâmetro	Onde	Obrigatório
`id`	path	sim
`sourceId`	path	sim

bash

curl -X DELETE "https://api.zapyflow.com.br/api/ai-agents/{id}/knowledge/{sourceId}" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"

Respostas

200 — OK
404 — Não encontrado — também é a resposta quando o recurso é de outro workspace

POST`/api/ai-agents/{id}/knowledge/{sourceId}/reindex`

Reprocessa uma fonte (re-extrai, re-chunka, re-embeda)

Escopo exigido: knowledge.write

Parâmetro	Onde	Obrigatório
`id`	path	sim
`sourceId`	path	sim

bash

curl -X POST "https://api.zapyflow.com.br/api/ai-agents/{id}/knowledge/{sourceId}/reindex" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"

Respostas

200 — OK
404 — Não encontrado — também é a resposta quando o recurso é de outro workspace

POST`/api/ai-agents/{id}/knowledge/text`

Adiciona um texto colado à base de conhecimento

Escopo exigido: knowledge.write

Parâmetro	Onde	Obrigatório
`id`	path	sim

Corpo da requisição

Campo	Tipo	Obrigatório	Restrições
`name`	`string`	sim	min 1, max 120
`content`	`string`	sim	min 1, max 200000

bash

curl -X POST "https://api.zapyflow.com.br/api/ai-agents/{id}/knowledge/text" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

Respostas

201 — Criado
409 — Conflito com o estado atual

POST`/api/ai-agents/{id}/knowledge/upload`

Sobe um arquivo (PDF/DOCX/MD/HTML/TXT) para a base de conhecimento

Escopo exigido: knowledge.write

Parâmetro	Onde	Obrigatório
`id`	path	sim

bash

curl -X POST "https://api.zapyflow.com.br/api/ai-agents/{id}/knowledge/upload" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"

Respostas

201 — Criado
400 — Requisição malformada
409 — Conflito com o estado atual

POST`/api/ai-agents/{id}/knowledge/url`

Adiciona uma página (URL) à base de conhecimento

Escopo exigido: knowledge.write

Parâmetro	Onde	Obrigatório
`id`	path	sim

Corpo da requisição

Campo	Tipo	Obrigatório	Restrições
`url`	`string`	sim	max 2000

bash

curl -X POST "https://api.zapyflow.com.br/api/ai-agents/{id}/knowledge/url" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

Respostas

201 — Criado
400 — Requisição malformada
409 — Conflito com o estado atual

GET`/api/ai-agents/{id}/metrics`

Métricas (7 dias) de um bot para o Resumo

Escopo exigido: agents.read

Parâmetro	Onde	Obrigatório
`id`	path	sim

bash

curl "https://api.zapyflow.com.br/api/ai-agents/{id}/metrics" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"

Respostas

200 — OK
404 — Não encontrado — também é a resposta quando o recurso é de outro workspace

POST`/api/ai-agents/{id}/upload-catalog`

Upload de catalogo PDF/imagem para o bot

Escopo exigido: catalog.write

Parâmetro	Onde	Obrigatório
`id`	path	sim

bash

curl -X POST "https://api.zapyflow.com.br/api/ai-agents/{id}/upload-catalog" \
  -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

POST`/api/ai-agents/{id}/upload-catalog-images`

Upload de multiplas imagens do catalogo/cardapio (max 6)

Escopo exigido: catalog.write

Parâmetro	Onde	Obrigatório
`id`	path	sim

bash

curl -X POST "https://api.zapyflow.com.br/api/ai-agents/{id}/upload-catalog-images" \
  -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/ai-agents/ai-adjust/scope`

Os campos que a edição por IA realmente escreve

Escopo exigido: agents.read

bash

curl "https://api.zapyflow.com.br/api/ai-agents/ai-adjust/scope" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"

Respostas

200 — OK

GET`/api/ai-agents/templates`

Listar templates de bot disponiveis por segmento

Escopo exigido: agents.read

bash

curl "https://api.zapyflow.com.br/api/ai-agents/templates" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"

Respostas

200 — OK

Bots

POST/api/ai-agents/{id}/apply-template

GET/api/ai-agents/{id}/catalog-items

POST/api/ai-agents/{id}/catalog-items

PATCH/api/ai-agents/{id}/catalog-items/{itemId}

DELETE/api/ai-agents/{id}/catalog-items/{itemId}

POST/api/ai-agents/{id}/faq

PATCH/api/ai-agents/{id}/faq/{faqId}

DELETE/api/ai-agents/{id}/faq/{faqId}

PATCH/api/ai-agents/{id}/faq/reorder

GET/api/ai-agents/{id}/knowledge

PATCH/api/ai-agents/{id}/knowledge/{sourceId}

DELETE/api/ai-agents/{id}/knowledge/{sourceId}

POST/api/ai-agents/{id}/knowledge/{sourceId}/reindex

POST/api/ai-agents/{id}/knowledge/text

POST/api/ai-agents/{id}/knowledge/upload

POST/api/ai-agents/{id}/knowledge/url

GET/api/ai-agents/{id}/metrics

POST/api/ai-agents/{id}/upload-catalog

POST/api/ai-agents/{id}/upload-catalog-images

GET/api/ai-agents/ai-adjust/scope

GET/api/ai-agents/templates

POST`/api/ai-agents/{id}/apply-template`

GET`/api/ai-agents/{id}/catalog-items`

POST`/api/ai-agents/{id}/catalog-items`

PATCH`/api/ai-agents/{id}/catalog-items/{itemId}`

DELETE`/api/ai-agents/{id}/catalog-items/{itemId}`

POST`/api/ai-agents/{id}/faq`

PATCH`/api/ai-agents/{id}/faq/{faqId}`

DELETE`/api/ai-agents/{id}/faq/{faqId}`

PATCH`/api/ai-agents/{id}/faq/reorder`

GET`/api/ai-agents/{id}/knowledge`

PATCH`/api/ai-agents/{id}/knowledge/{sourceId}`

DELETE`/api/ai-agents/{id}/knowledge/{sourceId}`

POST`/api/ai-agents/{id}/knowledge/{sourceId}/reindex`

POST`/api/ai-agents/{id}/knowledge/text`

POST`/api/ai-agents/{id}/knowledge/upload`

POST`/api/ai-agents/{id}/knowledge/url`

GET`/api/ai-agents/{id}/metrics`

POST`/api/ai-agents/{id}/upload-catalog`

POST`/api/ai-agents/{id}/upload-catalog-images`

GET`/api/ai-agents/ai-adjust/scope`

GET`/api/ai-agents/templates`