REST API

Documents

The company's knowledge base, with search for RAG.

  • GET /docs (tracker:read): knowledge base documents the person can read, without the text (title, slug, summary, project, visibility). Query: project (prefix, slug or id, or empresa for the ones for the whole company).
  • GET /docs/search?q=<question> (tracker:read): RAG search in the published documents. Returns the most relevant passages (up to 20, default 5; limit), each with the document, the section and the text. project narrows it to a project (the whole-company ones come along).
  • GET /docs/{slug or id} (tracker:read): the document with its markdown text (body). With ?format=markdown (or Accept: text/markdown), only the markdown.
  • POST /docs (tracker:write): creates a document, or updates the one with the same slug (201 when it creates, 200 when it updates). {"title": "...", "body": "<markdown>", "summary": "...", "project": "MOB", "slug": "...", "visibility": "draft|internal|public"}. Without project, the document belongs to the whole company (admins only). Good for publishing a repository's documentation from CI.