Knowledge
Fuentes de conocimiento
PUT/api/ai-agents/{id}/knowledge-bases
Definir qué bases lee este agente
Ámbito requerido: knowledge.write
| Parámetro | Dónde | Obligatorio |
|---|---|---|
id | path | sí |
Cuerpo de la petición
| Campo | Tipo | Obligatorio | Restricciones |
|---|---|---|---|
baseIds | string[] | sí | ≤ 20 items |
bash
curl -X PUT "https://api.zapyflow.com.br/api/ai-agents/{id}/knowledge-bases" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY" \
-H "Content-Type: application/json" \
-d '{ ... }'Respuestas
200— OK404— No encontrado — también es la respuesta cuando el recurso es de otro workspace422— Entendido, pero rechazado por una regla
GET/api/knowledge-bases
Bases de conocimiento del equipo
Ámbito requerido: knowledge.read
bash
curl "https://api.zapyflow.com.br/api/knowledge-bases" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Respuestas
200— OK
POST/api/knowledge-bases
Crear una base de conocimiento
Ámbito requerido: knowledge.write
Cuerpo de la petición
| Campo | Tipo | Obligatorio | Restricciones |
|---|---|---|---|
name | string | sí | min 1, max 80 |
description | string | no | max 500 |
bash
curl -X POST "https://api.zapyflow.com.br/api/knowledge-bases" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY" \
-H "Content-Type: application/json" \
-d '{ ... }'Respuestas
201— Creado409— Conflicto con el estado actual
PATCH/api/knowledge-bases/{id}
Renombrar una base de conocimiento o editar su descripción
Ámbito requerido: knowledge.write
| Parámetro | Dónde | Obligatorio |
|---|---|---|
id | path | sí |
Cuerpo de la petición
| Campo | Tipo | Obligatorio | Restricciones |
|---|---|---|---|
name | string | no | min 1, max 80 |
description | string | no | max 500 |
bash
curl -X PATCH "https://api.zapyflow.com.br/api/knowledge-bases/{id}" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY" \
-H "Content-Type: application/json" \
-d '{ ... }'Respuestas
200— OK404— No encontrado — también es la respuesta cuando el recurso es de otro workspace409— Conflicto con el estado actual
DELETE/api/knowledge-bases/{id}
Eliminar una base de conocimiento vacía
Ámbito requerido: knowledge.write
| Parámetro | Dónde | Obligatorio |
|---|---|---|
id | path | sí |
bash
curl -X DELETE "https://api.zapyflow.com.br/api/knowledge-bases/{id}" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Respuestas
204— Sin contenido404— No encontrado — también es la respuesta cuando el recurso es de otro workspace409— Conflicto con el estado actual
GET/api/knowledge-bases/{id}/sources
Las fuentes de una base de conocimiento
Ámbito requerido: knowledge.read
| Parámetro | Dónde | Obligatorio |
|---|---|---|
id | path | sí |
bash
curl "https://api.zapyflow.com.br/api/knowledge-bases/{id}/sources" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Respuestas
200— OK404— No encontrado — también es la respuesta cuando el recurso es de otro workspace