Knowledge Bases
Bases de conocimiento
PATCH/api/knowledge-bases/{id}/sources/{sourceId}
Activa, desactiva o renombra una fuente
Á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 | no | — |
name | string | no | min 1, max 120 |
bash
curl -X PATCH "https://api.zapyflow.com.br/api/knowledge-bases/{id}/sources/{sourceId}" \
-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 workspace
DELETE/api/knowledge-bases/{id}/sources/{sourceId}
Elimina una fuente de la base
Á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/knowledge-bases/{id}/sources/{sourceId}" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Respuestas
200— OK404— No encontrado — también es la respuesta cuando el recurso es de otro workspace
POST/api/knowledge-bases/{id}/sources/{sourceId}/reindex
Reprocesa una fuente
Á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/knowledge-bases/{id}/sources/{sourceId}/reindex" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Respuestas
202— Aceptado — en cola, aún no concluido404— No encontrado — también es la respuesta cuando el recurso es de otro workspace409— Conflicto con el estado actual
POST/api/knowledge-bases/{id}/sources/text
Añade un texto pegado a una 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/knowledge-bases/{id}/sources/text" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY" \
-H "Content-Type: application/json" \
-d '{ ... }'Respuestas
201— Creado404— No encontrado — también es la respuesta cuando el recurso es de otro workspace409— Conflicto con el estado actual
POST/api/knowledge-bases/{id}/sources/upload
Sube un archivo (PDF/DOCX/MD/HTML/TXT) a una 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/knowledge-bases/{id}/sources/upload" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Respuestas
201— Creado400— Petición malformada404— No encontrado — también es la respuesta cuando el recurso es de otro workspace409— Conflicto con el estado actual
POST/api/knowledge-bases/{id}/sources/url
Añade una página (URL) a una 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/knowledge-bases/{id}/sources/url" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY" \
-H "Content-Type: application/json" \
-d '{ ... }'Respuestas
201— Creado400— Petición malformada404— No encontrado — también es la respuesta cuando el recurso es de otro workspace409— Conflicto con el estado actual