API REST

Documentos

A base de conhecimento da empresa, com a busca para RAG.

  • GET /docs (tracker:read): documentos da base de conhecimento que a pessoa lê, sem o texto (título, slug, resumo, projeto, visibilidade). Query: project (prefixo, slug ou id, ou empresa para os da empresa toda).
  • GET /docs/search?q=<pergunta> (tracker:read): busca para RAG nos documentos publicados. Devolve os trechos mais relevantes (até 20, padrão 5; limit), cada um com o documento, a seção e o texto. project restringe a um projeto (os da empresa toda entram junto).
  • GET /docs/{slug ou id} (tracker:read): o documento com o texto em markdown (body). Com ?format=markdown (ou Accept: text/markdown), só o markdown.
  • POST /docs (tracker:write): cria um documento, ou atualiza o que tem o mesmo slug (201 quando cria, 200 quando atualiza). {"title": "...", "body": "<markdown>", "summary": "...", "project": "MOB", "slug": "...", "visibility": "draft|internal|public"}. Sem project, o documento é da empresa toda (só admin). Bom para publicar a documentação de um repositório pelo CI.