API REST

Documentos

La base de conocimiento de la empresa, con la búsqueda para RAG.

  • GET /docs (tracker:read): documentos de la base de conocimiento que la persona lee, sin el texto (título, slug, resumen, proyecto, visibilidad). Query: project (prefijo, slug o id, o empresa para los de toda la empresa).
  • GET /docs/search?q=<pregunta> (tracker:read): búsqueda para RAG en los documentos publicados. Devuelve los fragmentos más relevantes (hasta 20, por defecto 5; limit), cada uno con el documento, la sección y el texto. project lo restringe a un proyecto (los de toda la empresa entran también).
  • GET /docs/{slug o id} (tracker:read): el documento con el texto en markdown (body). Con ?format=markdown (o Accept: text/markdown), solo el markdown.
  • POST /docs (tracker:write): crea un documento, o actualiza el que tiene el mismo slug (201 cuando crea, 200 cuando actualiza). {"title": "...", "body": "<markdown>", "summary": "...", "project": "MOB", "slug": "...", "visibility": "draft|internal|public"}. Sin project, el documento es de toda la empresa (solo admin). Sirve para publicar la documentación de un repositorio desde el CI.