Base de Conhecimento & Assistente

Knowledge Hub

Guia de Operação & Boas Práticas

A central de conhecimento da sua squad. Repositório organizado para manuais técnicos, guias e assistente inteligente integrado.

Abrir Knowledge Hub

Sua Chave, Seu Controle

"Privacidade em primeiro lugar: sua API Key do Google AI Studio fica guardada apenas no seu próprio navegador via LocalStorage. O servidor nunca persiste nem compartilha suas credenciais."

Manual de Operação da Wiki & Assistente

Alimente a base de conhecimento e use o assistente para responder dúvidas do projeto.

Configuração de Key

Obtenha sua chave gratuita no Google AI Studio (Gemini Flash) e cole no painel de Configurações do módulo.

Gestão de Artigos

Crie e edite manuais técnicos em formato Markdown com suporte a diagramas, código-fonte e categorias.

Assistente Contextual

Inicie conversas com respostas geradas por streaming e fundamentadas diretamente nos documentos salvos da squad.

Lixeira Comunitária

Documentos excluídos ficam retidos por 30 dias na lixeira, permitindo restauração rápida por qualquer membro autorizado.

Integração de Máquina & API

API REST & Ferramentas do Base de Conhecimento

Listar, buscar, baixar e criar documentos da KB de fora da aplicação.

Header: X-Api-Key

Como Obter sua Chave e Autenticar

Toda chamada exige o envio do header X-Api-Key: ask_.... Você pode gerar sua chave pessoal em Meu Espaço → Conectividade ou via painel de administração em Admin → API Keys.

Endpoints REST Disponíveis

GET/api/v1/knowledge/docs

Lista documentos publicados, com busca e filtros.

Parâmetros: q (título/conteúdo), category, tag, page (1-based, padrão 1), pageSize (padrão 20, máx 100)

Retorno: { docs[], page, pageSize, total, totalPages } — cada doc traz contentPreview de 240 caracteres, sem o conteúdo inteiro

GET/api/v1/knowledge/docs/{id}

Documento completo, com o conteúdo convertido.

Parâmetros: format = html (padrão) | md | txt

Retorno: documento + content no formato pedido

GET/api/v1/knowledge/docs/{id}/download

Mesma coisa, mas como arquivo para download.

Parâmetros: format = md (padrão) | html | txt

Retorno: corpo do arquivo + Content-Disposition: attachment com o título em slug

POST/api/v1/knowledge/docs

Cria um documento novo já publicado.

Parâmetros: body { title (obrigatório), content, category, tags: string[] | "a,b,c" }

Retorno: 201 com o documento salvo

Exemplo Prático de Chamada

cURL

curl -s "https://espacoagil.com.br/api/v1/knowledge/docs?q=onboarding&page=1&pageSize=20" \
  -H "X-Api-Key: ask_SUA_CHAVE_AQUI"

Exemplo de Resposta (JSON):

JSON

{
  "docs": [
    {
      "id": "8f3c...",
      "title": "Onboarding da squad",
      "category": "Processos",
      "tags": ["onboarding"],
      "byteSize": 4821,
      "status": "published",
      "updatedAt": "2026-09-01T13:22:10.000Z",
      "contentPreview": "Checklist do primeiro dia..."
    }
  ],
  "page": 1, "pageSize": 20, "total": 37, "totalPages": 2
}

Regras de Negócio & Detalhes de Integração

A listagem nunca devolve o conteúdo inteiro — só o contentPreview. Para o texto completo, chame GET /docs/{id}.
Documentos em lixeira (status trash/deleted) ficam fora de qualquer resposta, inclusive no acesso direto por id.
Documento criado pela API fica com authorId "api:<8 primeiros caracteres do hash da chave>", então dá pra rastrear qual chave escreveu o quê.
A busca por q é feita em memória, depois de ler a collection inteira: com uma KB muito grande a resposta fica lenta.