Referência da API › Recursos
Brain
Notas em Markdown ligadas por [[links]], em pastas, no estilo Obsidian. Crie, edite, mova, busque e suba arquivos.
O Brain funciona como um cofre do Obsidian: cada documento é uma nota com um caminho (pasta/nome), e as notas se ligam com [[Nome da nota]]. Arquivos enviados (PDF, Word, Excel) viram notas com o texto extraído.
| Sintaxe | O que faz |
|---|---|
[[Nota]], [[Pasta/Nota]] | Link para outra nota. Sem pasta, vale o nome (a nota da mesma pasta tem preferência). |
[[Nota#Título]], [[Nota|texto]] | Link para um título da nota, ou com outro texto. |
![[Nota]], ![[Nota#Título]] | Mostra o conteúdo da outra nota (ou da seção) dentro desta. |
#tag, #tag/subtag | Tag. Também vale tags: nas propriedades. |
--- no topo | Propriedades (front matter YAML), como tags, aliases e campos livres. |
GET/api/knowledge#
Lista as notas que você pode ver e as pastas, sem o texto completo.
{
"docs": [
{
"id": "kno_2c4e6a8b0d1f",
"title": "Política de reembolso",
"name": "Política de reembolso",
"folder": "Comercial",
"path": "Comercial/Política de reembolso",
"attachment": false,
"size": 18420,
"preview": "Clientes podem pedir reembolso em até 30 dias…",
"tags": ["comercial"],
"aliases": ["Reembolso"],
"links": ["kno_7e9f1a3b5c2d"],
"unresolved": ["Plano de expansão"],
"scope": "organization",
"ownerId": "usr_1a2b3c4d5e6f",
"canEdit": true,
"usedBy": [{ "id": "agt_8f3a2b1c9d0e", "name": "Suporte" }],
"createdAt": "2026-10-22T11:00:00.000Z",
"updatedAt": "2026-10-29T15:20:00.000Z"
}
],
"folders": ["Clientes", "Comercial", "Produto/Guias"]
}| Campo | Descrição |
|---|---|
name | O título sem .md. É o nome usado nos links. |
path | pasta/nome, a chave completa dos links. |
attachment | true para arquivos enviados (PDF, Word, Excel, CSV, JSON, texto). |
links | IDs das notas para onde esta aponta. |
unresolved | Links para notas que ainda não existem. |
size | Tamanho do texto em caracteres. |
usedBy | Agentes que consultam a nota. |
POST/api/knowledge#
Cria uma nota a partir de texto ou Markdown.
| Campo | Tipo | Descrição |
|---|---|---|
title | string, 1 a 160 | Obrigatório. / \ [ ] # ^ | saem do nome. Se já existir uma nota com esse nome na pasta, ganha um número (Reunião 1). |
content | string, até 2 milhões de caracteres | Texto da nota. Padrão: vazio. |
folder | string | Pasta, como Clientes/Reuniões. Padrão: a raiz. |
scope, teamId | personal (padrão), team ou organization. organization exige ser administrador. |
curl -X POST https://doublex.ai/api/knowledge \
-H "Authorization: Bearer $DOUBLEX_API_KEY" \
-H "Content-Type: application/json" \
-d '{"title": "Tabela de preços 2026", "folder": "Comercial", "content": "Plano Básico: R$ 99/mês. Ver [[Política de reembolso]]."}'Resposta 201: { "doc": { "id": "...", "title": "Tabela de preços 2026", "folder": "Comercial" } }.
GET/api/knowledge/{id}#
Devolve a nota com o texto completo em doc.content e o que o painel lateral mostra:
| Campo | Descrição |
|---|---|
properties | As propriedades do topo da nota. |
headings | Os títulos (level, text, line). |
outgoing | Links de saída: target como escrito e id da nota (null se ainda não existe). |
backlinks | Notas que linkam para esta, com as linhas do link em snippets. |
unlinked | Notas que citam o nome (ou um alias) sem link. |
PATCH/api/knowledge/{id}#
Edita, renomeia ou move uma nota. Exige permissão de edição.
| Campo | Descrição |
|---|---|
content | Novo texto. |
title | Novo nome. |
folder | Nova pasta ("" é a raiz). |
updateLinks | Padrão true: ao renomear ou mover, os links nas outras notas que você pode editar acompanham. |
curl -X PATCH https://doublex.ai/api/knowledge/kno_2c4e6a8b0d1f \
-H "Authorization: Bearer $DOUBLEX_API_KEY" \
-H "Content-Type: application/json" \
-d '{"title": "Política de reembolso e cancelamento"}'Resposta: { "doc": { ... }, "updatedLinks": 4, "updatedNotes": 3 }. Se já existir uma nota no caminho novo, a resposta é 409.
Pastas#
Pastas vêm das notas. Uma pasta vazia fica guardada só para quem a criou.
| Rota | O que faz |
|---|---|
GET /api/knowledge/folders | Lista as pastas: { "folders": [...] }. |
POST /api/knowledge/folders | Cria uma pasta vazia: { "path": "Clientes/Reuniões" }. |
PATCH /api/knowledge/folders | Renomeia ou move uma pasta com as subpastas: { "from": "Comercial", "to": "Vendas/Comercial" }. Os links acompanham. Notas que você não pode editar ficam onde estão e entram em skipped. |
DELETE /api/knowledge/folders?path=Arquivo | Apaga uma pasta vazia. Com notas dentro, a resposta é 409. |
POST /api/knowledge/delete | Exclui de uma vez notas e pastas inteiras (com subpastas e as notas de dentro): { "ids": ["kno_..."], "folders": ["Arquivo"], "expected": 14 }. Não há lixeira: é definitivo. Só saem as notas que você pode editar; as outras ficam onde estão e entram em kept. As notas excluídas saem dos agentes que as usavam. Com expected (quantas notas você confirmou), a resposta é 409 se o Brain mudou nesse meio-tempo. Resposta: { "deleted": 14, "kept": 0, "detachedAgents": 1, "folders": [...] }. |
POST/api/knowledge/upload#
Sobe um arquivo. O texto é extraído no servidor. Corpo em multipart/form-data:
| Campo | Descrição |
|---|---|
file | Obrigatório. PDF, Word (.docx), Excel (.xlsx), CSV, JSON, Markdown ou texto. Até 20 MB. |
title | Nome. Padrão: o nome do arquivo. Nome repetido na pasta ganha um número. |
folder | Pasta de destino. |
replace | ID de uma nota existente: troca o texto dela pelo do arquivo e mantém o ID, o nome, a pasta e os agentes ligados. |
scope | personal (padrão), team ou organization. organization exige ser administrador. |
teamId | O time, quando scope é team. Você precisa ser membro. |
curl -X POST https://doublex.ai/api/knowledge/upload \
-H "Authorization: Bearer $DOUBLEX_API_KEY" \
-F "[email protected]" \
-F "folder=Comercial" \
-F "scope=organization"Resposta 201: { "doc": { "id": "kno_2c4e6a8b0d1f", "title": "politica-de-reembolso.pdf" }, "chars": 18420 }. Com replace, a resposta é 200 e traz "replaced": true.
| Status | Quando |
|---|---|
413 | Arquivo maior que 20 MB. |
422 | Formato não suportado, arquivo vazio ou corrompido, PDF só com imagens, arquivo protegido por senha. |
403 | Você não pode criar nesse escopo. |
404 | A nota de replace não existe ou você não pode editá-la. |
GET/api/knowledge/search#
Busca nas notas que você pode ver.
| Query | Descrição |
|---|---|
q | Obrigatório. De 2 a 300 caracteres. |
limit | Quantos trechos devolver, de 1 a 50. Padrão 8. |
A busca aceita os operadores do Obsidian:
| Operador | Exemplo | Filtra |
|---|---|---|
tag: | tag:#cliente | Notas com a tag (ou uma subtag dela). |
path: | path:Comercial | Notas cujo caminho contém o texto. |
file: | file:reunião | Notas cujo nome contém o texto. |
"..." | "prazo de reembolso" | A frase exata. |
- | -rascunho | Tira as notas com a palavra. |
curl "https://doublex.ai/api/knowledge/search?q=prazo%20path%3AComercial&limit=3" -H "Authorization: Bearer $DOUBLEX_API_KEY"{
"results": [
{ "docId": "kno_2c4e6a8b0d1f", "title": "Política de reembolso", "score": 1, "text": "…o cliente pode pedir reembolso em até 30 dias…" }
],
"notes": [
{ "id": "kno_2c4e6a8b0d1f", "name": "Política de reembolso", "path": "Comercial/Política de reembolso", "score": 2, "matches": [{ "line": 2, "text": "Clientes podem pedir reembolso em até 30 dias." }] }
]
}results são trechos pontuados, a mesma busca que os agentes usam. notes agrupa por nota, com as linhas encontradas. Sem acentos nem maiúsculas fazendo diferença; palavras com até duas letras são ignoradas em results.
DELETE/api/knowledge/{id}#
Apaga a nota e a tira dos agentes que a usavam. Exige permissão de edição; sem ela, a resposta é 404.
Resposta: { "ok": true }.