Knowledge Bases
Bases de conhecimento
PATCH/api/knowledge-bases/{id}/sources/{sourceId}
Liga, desliga ou renomeia uma fonte
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 | não | — |
name | string | não | 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 '{ ... }'Respostas
200— OK404— Não encontrado — também é a resposta quando o recurso é de outro workspace
DELETE/api/knowledge-bases/{id}/sources/{sourceId}
Remove uma fonte da base
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/knowledge-bases/{id}/sources/{sourceId}" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Respostas
200— OK404— Não encontrado — também é a resposta quando o recurso é de outro workspace
POST/api/knowledge-bases/{id}/sources/{sourceId}/reindex
Reprocessa uma fonte
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/knowledge-bases/{id}/sources/{sourceId}/reindex" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Respostas
202— Aceito — enfileirado, ainda não concluído404— Não encontrado — também é a resposta quando o recurso é de outro workspace409— Conflito com o estado atual
POST/api/knowledge-bases/{id}/sources/text
Adiciona um texto colado a uma 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/knowledge-bases/{id}/sources/text" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY" \
-H "Content-Type: application/json" \
-d '{ ... }'Respostas
201— Criado404— Não encontrado — também é a resposta quando o recurso é de outro workspace409— Conflito com o estado atual
POST/api/knowledge-bases/{id}/sources/upload
Sobe um arquivo (PDF/DOCX/MD/HTML/TXT) para uma 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/knowledge-bases/{id}/sources/upload" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Respostas
201— Criado400— Requisição malformada404— Não encontrado — também é a resposta quando o recurso é de outro workspace409— Conflito com o estado atual
POST/api/knowledge-bases/{id}/sources/url
Adiciona uma página (URL) a uma 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/knowledge-bases/{id}/sources/url" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY" \
-H "Content-Type: application/json" \
-d '{ ... }'Respostas
201— Criado400— Requisição malformada404— Não encontrado — também é a resposta quando o recurso é de outro workspace409— Conflito com o estado atual