Knowledge
Fontes de conhecimento
PUT/api/ai-agents/{id}/knowledge-bases
Definir quais bases este agente lê
Escopo exigido: knowledge.write
| Parâmetro | Onde | Obrigatório |
|---|---|---|
id | path | sim |
Corpo da requisição
| Campo | Tipo | Obrigatório | Restrições |
|---|---|---|---|
baseIds | string[] | sim | ≤ 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 '{ ... }'Respostas
200— OK404— Não encontrado — também é a resposta quando o recurso é de outro workspace422— Entendido, mas recusado por uma regra
GET/api/knowledge-bases
Bases de conhecimento do time
Escopo exigido: knowledge.read
bash
curl "https://api.zapyflow.com.br/api/knowledge-bases" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Respostas
200— OK
POST/api/knowledge-bases
Criar base de conhecimento
Escopo exigido: knowledge.write
Corpo da requisição
| Campo | Tipo | Obrigatório | Restrições |
|---|---|---|---|
name | string | sim | min 1, max 80 |
description | string | não | 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 '{ ... }'Respostas
201— Criado409— Conflito com o estado atual
PATCH/api/knowledge-bases/{id}
Renomear base de conhecimento ou editar a descrição
Escopo exigido: knowledge.write
| Parâmetro | Onde | Obrigatório |
|---|---|---|
id | path | sim |
Corpo da requisição
| Campo | Tipo | Obrigatório | Restrições |
|---|---|---|---|
name | string | não | min 1, max 80 |
description | string | não | 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 '{ ... }'Respostas
200— OK404— Não encontrado — também é a resposta quando o recurso é de outro workspace409— Conflito com o estado atual
DELETE/api/knowledge-bases/{id}
Apagar base de conhecimento vazia
Escopo exigido: knowledge.write
| Parâmetro | Onde | Obrigatório |
|---|---|---|
id | path | sim |
bash
curl -X DELETE "https://api.zapyflow.com.br/api/knowledge-bases/{id}" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Respostas
204— Sem conteúdo404— Não encontrado — também é a resposta quando o recurso é de outro workspace409— Conflito com o estado atual
GET/api/knowledge-bases/{id}/sources
Fontes de uma base de conhecimento
Escopo exigido: knowledge.read
| Parâmetro | Onde | Obrigatório |
|---|---|---|
id | path | sim |
bash
curl "https://api.zapyflow.com.br/api/knowledge-bases/{id}/sources" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Respostas
200— OK404— Não encontrado — também é a resposta quando o recurso é de outro workspace