Bots

Compatibilidad: rutas antiguas de Agente de IA

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

Aplicar una plantilla al agente (sobrescribe configuración y FAQ)

Ámbito requerido: agents.write

Parámetro	Dónde	Obligatorio
`id`	path	sí

Cuerpo de la petición

Campo	Tipo	Obligatorio	Restricciones
`templateId`	`string`	sí	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 '{ ... }'

Respuestas

200 — OK
400 — Petición malformada
404 — No encontrado — también es la respuesta cuando el recurso es de otro workspace

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

Lista los ítems de catálogo del agente

Ámbito requerido: catalog.read

Parámetro	Dónde	Obligatorio
`id`	path	sí

bash

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

Respuestas

200 — OK
404 — No encontrado — también es la respuesta cuando el recurso es de otro workspace

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

Crea un ítem de catálogo

Ámbito requerido: catalog.write

Parámetro	Dónde	Obligatorio
`id`	path	sí

Cuerpo de la petición

Campo	Tipo	Obligatorio	Restricciones
`name`	`string`	sí	min 1, max 150
`description`	`string`	no	max 1000
`price`	`number`	sí	≥ 0
`imageUrl`	`object \| string \| null`	no	—
`category`	`object \| string \| null`	no	—
`active`	`boolean`	no	—
`order`	`integer`	no	—

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 '{ ... }'

Respuestas

201 — Creado
404 — No encontrado — también es la respuesta cuando el recurso es de otro workspace

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

Edita un ítem de catálogo

Ámbito requerido: catalog.write

Parámetro	Dónde	Obligatorio
`id`	path	sí
`itemId`	path	sí

Cuerpo de la petición

Campo	Tipo	Obligatorio	Restricciones
`name`	`string`	no	min 1, max 150
`description`	`string`	no	max 1000
`price`	`number`	no	≥ 0
`imageUrl`	`object \| string \| null`	no	—
`category`	`object \| string \| null`	no	—
`active`	`boolean`	no	—
`order`	`integer`	no	—

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 '{ ... }'

Respuestas

200 — OK
404 — No encontrado — también es la respuesta cuando el recurso es de otro workspace

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

Elimina un ítem de catálogo sin tocar el recurso externo del proveedor

Ámbito requerido: catalog.write

Parámetro	Dónde	Obligatorio
`id`	path	sí
`itemId`	path	sí

bash

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

Respuestas

204 — CatalogItem removido com sucesso
404 — No encontrado — también es la respuesta cuando el recurso es de otro workspace

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

Añadir una FAQ al agente

Ámbito requerido: agents.write

Parámetro	Dónde	Obligatorio
`id`	path	sí

Cuerpo de la petición

Campo	Tipo	Obligatorio	Restricciones
`question`	`string`	sí	min 1, max 500
`answer`	`string`	sí	min 1, max 2000
`order`	`integer`	no	≥ 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 '{ ... }'

Respuestas

201 — Creado
400 — Petición malformada

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

Editar una FAQ del agente

Ámbito requerido: agents.write

Parámetro	Dónde	Obligatorio
`id`	path	sí
`faqId`	path	sí

Cuerpo de la petición

Campo	Tipo	Obligatorio	Restricciones
`question`	`string`	no	min 1, max 500
`answer`	`string`	no	min 1, max 2000
`order`	`integer`	no	≥ 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 '{ ... }'

Respuestas

200 — OK
404 — No encontrado — también es la respuesta cuando el recurso es de otro workspace

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

Eliminar una FAQ del agente

Ámbito requerido: agents.write

Parámetro	Dónde	Obligatorio
`id`	path	sí
`faqId`	path	sí

bash

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

Respuestas

200 — OK
404 — No encontrado — también es la respuesta cuando el recurso es de otro workspace

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

Reordenar las FAQ del agente

Ámbito requerido: agents.write

Parámetro	Dónde	Obligatorio
`id`	path	sí

Cuerpo de la petición

Campo	Tipo	Obligatorio	Restricciones
`orderedIds`	`string[]`	sí	≥ 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 '{ ... }'

Respuestas

200 — OK
400 — Petición malformada

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

Lista las fuentes de la base de conocimiento del agente

Ámbito requerido: knowledge.read

Parámetro	Dónde	Obligatorio
`id`	path	sí

bash

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

Respuestas

200 — OK
403 — Prohibido, o la clave no tiene este ámbito

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

Activa o desactiva una fuente (sin reindexar)

Ámbito requerido: knowledge.write

Parámetro	Dónde	Obligatorio
`id`	path	sí
`sourceId`	path	sí

Cuerpo de la petición

Campo	Tipo	Obligatorio	Restricciones
`enabled`	`boolean`	sí	—

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 '{ ... }'

Respuestas

200 — OK
404 — No encontrado — también es la respuesta cuando el recurso es de otro workspace

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

Elimina una fuente y sus fragmentos indexados

Ámbito requerido: knowledge.write

Parámetro	Dónde	Obligatorio
`id`	path	sí
`sourceId`	path	sí

bash

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

Respuestas

200 — OK
404 — No encontrado — también es la respuesta cuando el recurso es de otro workspace

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

Reprocesa una fuente (re-extrae, re-fragmenta, re-incrusta)

Ámbito requerido: knowledge.write

Parámetro	Dónde	Obligatorio
`id`	path	sí
`sourceId`	path	sí

bash

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

Respuestas

200 — OK
404 — No encontrado — también es la respuesta cuando el recurso es de otro workspace

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

Añade un texto pegado a la base de conocimiento

Ámbito requerido: knowledge.write

Parámetro	Dónde	Obligatorio
`id`	path	sí

Cuerpo de la petición

Campo	Tipo	Obligatorio	Restricciones
`name`	`string`	sí	min 1, max 120
`content`	`string`	sí	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 '{ ... }'

Respuestas

201 — Creado
409 — Conflicto con el estado actual

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

Sube un archivo (PDF/DOCX/MD/HTML/TXT) a la base de conocimiento

Ámbito requerido: knowledge.write

Parámetro	Dónde	Obligatorio
`id`	path	sí

bash

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

Respuestas

201 — Creado
400 — Petición malformada
409 — Conflicto con el estado actual

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

Añade una página (URL) a la base de conocimiento

Ámbito requerido: knowledge.write

Parámetro	Dónde	Obligatorio
`id`	path	sí

Cuerpo de la petición

Campo	Tipo	Obligatorio	Restricciones
`url`	`string`	sí	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 '{ ... }'

Respuestas

201 — Creado
400 — Petición malformada
409 — Conflicto con el estado actual

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

Métricas de 7 días de un agente para el resumen

Ámbito requerido: agents.read

Parámetro	Dónde	Obligatorio
`id`	path	sí

bash

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

Respuestas

200 — OK
404 — No encontrado — también es la respuesta cuando el recurso es de otro workspace

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

Sube un catálogo en PDF o imagen

Ámbito requerido: catalog.write

Parámetro	Dónde	Obligatorio
`id`	path	sí

bash

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

Respuestas

200 — OK
400 — Petición malformada
404 — No encontrado — también es la respuesta cuando el recurso es de otro workspace

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

Sube varias imágenes del catálogo o menú (máx. 6)

Ámbito requerido: catalog.write

Parámetro	Dónde	Obligatorio
`id`	path	sí

bash

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

Respuestas

200 — OK
400 — Petición malformada
404 — No encontrado — también es la respuesta cuando el recurso es de otro workspace

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

Los campos que la edición por IA realmente escribe

Ámbito requerido: agents.read

bash

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

Respuestas

200 — OK

GET`/api/ai-agents/templates`

Listar las plantillas de agente disponibles por segmento

Ámbito requerido: agents.read

bash

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

Respuestas

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`