Skip to main content

Source: docs/manual/knowledge-bases.md

This page is generated by site/scripts/sync-manual-docs.mjs.

Knowledge Bases

Knowledge Bases provide tenant-scoped retrieval context for supervisor and single-agent runs.

Source: cmd/ui/frontend/src/pages/KnowledgeBasesPage.tsx, cmd/ui/knowledge_bases_handler.go, internal/knowledgebase/*

UI Surface​

Route: /knowledge-bases

The page supports:

  • Create KB via modal (CreateKnowledgeBaseModal).
  • Edit metadata (name, description, status, tags).
  • Configure embedding model and vector store settings.
  • Upload KB documents (multipart/form-data).
  • Trigger embedding workflow execution.
  • Apply KB linkage to prompt registry agent/version.
  • Delete KB through Temporal-backed delete workflow.

Runtime API​

  • GET /api/knowledge-bases
  • POST /api/knowledge-bases
  • GET /api/knowledge-bases/{id}
  • PUT /api/knowledge-bases/{id}
  • DELETE /api/knowledge-bases/{id}
  • POST /api/knowledge-bases/{id}/upload
  • POST /api/knowledge-bases/{id}/embed

Role model from runtime route registration:

  • Viewer: list/get
  • Editor: create/update/delete/upload/embed

Data and Workflow Model​

  • Metadata and documents are persisted in Postgres via internal/knowledgebase store implementations.
  • Embedding and deletion run through Temporal workflows:
    • knowledgebase.EmbedWorkflowTypeName
    • knowledgebase.DeleteWorkflowTypeName
  • Optional wait=true query mode allows synchronous completion waiting for embed/delete calls.

Run Integration​

Knowledge Base IDs selected in New Run are sent to supervisor APIs and incorporated into:

  • Preflight prompt/context preview
  • Fused KB snippets displayed before launch
  • Compliance and risk scoring used in preview

See Run Orchestration.