Skip to content
UseAgent star-knot markUseAgent
Esc
navigateopen⌘Jpreview
On this page

Knowledge and wiki

Reference material an agent can search, and published documents generated from a repository. The /knowledge and /wiki surfaces.

Knowledge is what an organization wants an agent to be able to look up. It comes in two forms: discrete facts and conventions, and longer published documents.

Knowledge

/knowledge is a gallery of the facts and conventions UseAgent remembers across runs. It is reference material, not executable instructions. Under the hood it is searchable and revisioned:

Operation Endpoint
Search POST /api/knowledge/search
Ingest POST /api/knowledge/ingest
List, edit, remove GET, PATCH, DELETE /api/knowledge
Documents GET, POST, PATCH /api/knowledge/documents
Publish, archive, revisions .../documents/:id/publish, /archive, /revisions

An agent reaches the same material in a run through the knowledge gateway tools.

Wiki

/wiki lists published documents, and /wiki/:id shows one with a navigation rail. A wiki document is generated, not hand-written:

Point at a repository

Generation starts from a repository, via POST /api/wiki/generate.

Read and structure

The repository is cloned and read, and the content, its file tree, manifests, config, and code, is structured into pages by a model.

Publish as knowledge

The pages are published as org-scoped knowledge documents with revisions, so they are retrievable by agents afterward.

Generation is a tracked job (GET /api/wiki/generate/:jobId), deduplicated per organization and repository so two requests do not race.

Was this page helpful?