Skip to content

Beta module namespace

knowledge

Beta routes may change with notice and are NOT covered by the 24-month stable window of the core contract.

Every module route is enumerated with method, path, auth and required permission; request/response schemas are not published for the beta surface.

53 operations

MethodPathRequired permissionAuthenticationSummary
get/v1/m/knowledge/context-policiesknowledge:context:readBearer tokenLists context policies, optionally filtered by scope.
post/v1/m/knowledge/context-policiesknowledge:context:writeBearer tokenUpserts a context/compaction policy by (scope_kind, scope_ref).
get/v1/m/knowledge/data-productsknowledge:data_product:readBearer tokenknowledge module route (requires knowledge:data_product:read)
post/v1/m/knowledge/data-productsknowledge:data_product:writeBearer tokenknowledge module route (requires knowledge:data_product:write)
get/v1/m/knowledge/data-products/{id}knowledge:data_product:readBearer tokenknowledge module route (requires knowledge:data_product:read)
put/v1/m/knowledge/data-products/{id}knowledge:data_product:writeBearer tokenknowledge module route (requires knowledge:data_product:write)
delete/v1/m/knowledge/data-products/{id}knowledge:data_product:adminBearer tokenknowledge module route (requires knowledge:data_product:admin)
post/v1/m/knowledge/data-products/{id}/archiveknowledge:data_product:adminBearer tokenknowledge module route (requires knowledge:data_product:admin)
get/v1/m/knowledge/data-products/{id}/contractsknowledge:data_product:readBearer tokenknowledge module route (requires knowledge:data_product:read)
post/v1/m/knowledge/data-products/{id}/contractsknowledge:data_product:writeBearer tokenknowledge module route (requires knowledge:data_product:write)
get/v1/m/knowledge/data-products/{id}/contracts/activeknowledge:data_product:readBearer tokenknowledge module route (requires knowledge:data_product:read)
get/v1/m/knowledge/data-products/{id}/contracts/{ver}knowledge:data_product:readBearer tokenknowledge module route (requires knowledge:data_product:read)
post/v1/m/knowledge/data-products/{id}/deprecateknowledge:data_product:writeBearer tokenknowledge module route (requires knowledge:data_product:write)
get/v1/m/knowledge/data-products/{id}/eventsknowledge:data_product:readBearer tokenknowledge module route (requires knowledge:data_product:read)
get/v1/m/knowledge/data-products/{id}/healthknowledge:data_product:readBearer tokenknowledge module route (requires knowledge:data_product:read)
post/v1/m/knowledge/data-products/{id}/publishknowledge:data_product:writeBearer tokenknowledge module route (requires knowledge:data_product:write)
post/v1/m/knowledge/data-products/{id}/validateknowledge:data_product:writeBearer tokenknowledge module route (requires knowledge:data_product:write)
get/v1/m/knowledge/dlp/rulesknowledge:dlp:readBearer tokenLists the tenant's DLP rules.
put/v1/m/knowledge/dlp/rulesknowledge:dlp:adminBearer tokenUpserts one DLP rule by class (admin-tier: writing egress policy is privileged governance; self-audited).
delete/v1/m/knowledge/dlp/rules/{id}knowledge:dlp:adminBearer tokenRemoves one DLP rule by id (admin-tier; self-audited). Removing the last rule disables the gate entirely — the audit row is the record of WHO opened the perimeter.
get/v1/m/knowledge/documents/{id}knowledge:kb:readBearer tokenReturns one document's metadata + provenance (no body).
get/v1/m/knowledge/kbsknowledge:kb:readBearer tokenLists knowledge bases, optionally filtered by status.
post/v1/m/knowledge/kbsknowledge:kb:writeBearer tokenDeclares a knowledge base.
get/v1/m/knowledge/kbs/{id}knowledge:kb:readBearer tokenknowledge module route (requires knowledge:kb:read)
put/v1/m/knowledge/kbs/{id}knowledge:kb:writeBearer tokenUpdates a KB's governance settings (classification/residency/ embed policy/default ACL/status), version-checked, re-validating the embed gate.
delete/v1/m/knowledge/kbs/{id}knowledge:kb:adminBearer tokenDeletes a KB and CASCADES its documents, chunks and document sensitivity labels in one transaction (no orphans).
get/v1/m/knowledge/kbs/{id}/documentsknowledge:kb:readBearer tokenLists a KB's ingested documents (metadata only; no body).
post/v1/m/knowledge/kbs/{id}/ingestknowledge:kb:writeBearer tokenIngests content into a knowledge base: it gathers documents (from a registered source or inline), REDACTS each body, chunks it, embeds the chunks via the wired embedder OUTSIDE the store transaction (the network/ egress call must never hold the single SQLite writer — the deploy discipline), and persists documents + chunks in one transaction.
post/v1/m/knowledge/kbs/{id}/queryknowledge:retrieval:readBearer tokenknowledge module route (requires knowledge:retrieval:read)
post/v1/m/knowledge/kbs/{id}/reindexknowledge:kb:writeBearer tokenRe-embeds a KB's chunks that have no embedding yet (the recovery path for a partial ingest where the embed call failed).
post/v1/m/knowledge/kbs/{id}/scanknowledge:scan:writeBearer tokenRuns the at-rest discovery scan over one KB's stored documents: classify every chunk's (redacted) text, label each document, count redaction markers, append the scan evidence row.
post/v1/m/knowledge/kbs/{id}/syncknowledge:kb:writeBearer tokenHandles POST /kbs/{id}/sync.
get/v1/m/knowledge/labelsknowledge:scan:readBearer tokenLists sensitivity labels, optionally filtered by subject_kind and/or kb_id (labels are governance metadata — counts and rules, no content).
get/v1/m/knowledge/lineageknowledge:lineage:readBearer tokenLists lineage records, optionally filtered by kb_id, agent_ref or decision.
get/v1/m/knowledge/lineage/{id}knowledge:lineage:readBearer tokenReturns one lineage record (self-audited).
get/v1/m/knowledge/memoryknowledge:memory:readBearer tokenLists the memory visible to the DECLARED read context (?agent_ref= plus the ?user_ref=/?session_ref= namespace), EXCLUDING expired entries (lazy expiry), entries above the reader's classification clearance, and entries that fail the integrity self-check (fail closed; withheld count reported, detection audited).
post/v1/m/knowledge/memoryknowledge:memory:writeBearer tokenUpserts an agent memory entry (by agent_ref + namespace + key), redacting the content and enforcing the per-agent quota.
get/v1/m/knowledge/memory/allknowledge:memory:adminBearer tokenknowledge module route (requires knowledge:memory:admin)
get/v1/m/knowledge/memory/exportknowledge:memory:readBearer tokenStreams the caller's clearance-visible memory as signed JSONL: line 1 is the signed manifest, each following line one memPortRow.
post/v1/m/knowledge/memory/importknowledge:memory:writeBearer tokenIngests a signed memory-portability bundle.
post/v1/m/knowledge/memory/purgeknowledge:memory:adminBearer tokenMaterializes expiry: it deletes expired memory entries of BOTH scopes (optionally for one agent).
post/v1/m/knowledge/memory/verifyknowledge:memory:adminBearer tokenknowledge module route (requires knowledge:memory:admin)
get/v1/m/knowledge/memory/{id}knowledge:memory:readBearer tokenReturns one memory entry.
delete/v1/m/knowledge/memory/{id}knowledge:memory:writeBearer tokenRemoves one memory entry.
get/v1/m/knowledge/promptsknowledge:prompt:readBearer tokenknowledge module route (requires knowledge:prompt:read)
post/v1/m/knowledge/promptsknowledge:prompt:writeBearer tokenCreates a prompt and its first immutable revision.
get/v1/m/knowledge/prompts/{id}knowledge:prompt:readBearer tokenReturns one prompt (its current pointer + status).
get/v1/m/knowledge/prompts/{id}/revisionsknowledge:prompt:readBearer tokenLists a prompt's immutable revision history.
post/v1/m/knowledge/prompts/{id}/revisionsknowledge:prompt:writeBearer tokenAppends an immutable revision and advances the current pointer.
get/v1/m/knowledge/prompts/{id}/revisions/{rev}knowledge:prompt:readBearer tokenReturns one immutable revision by number.
post/v1/m/knowledge/prompts/{id}/rollbackknowledge:prompt:writeBearer tokenPoints the prompt's current revision at a prior, existing revision.
get/v1/m/knowledge/scansknowledge:scan:readBearer tokenLists the append-only discovery scan evidence.
post/v1/m/knowledge/sources/{name}/scanknowledge:scan:writeBearer tokenRuns discovery ACROSS a configured document store WITHOUT ingesting: it pulls the source's documents (bounded like ingest), classifies the RAW bodies in memory and persists labels + the scan evidence — the bodies themselves are never stored, logged or embedded (zero egress, minimal data).