Feature · Knowledge
Documents
Keep sources that workers can search and cite.
How it works
Add a document
On Documents, select Add a document. Give a title, an optional source URL and the body in Markdown. Select Add and index. Agent splits it into parts and indexes them. Members and above can add and edit documents.
Search
The Search tab searches what workers can cite. You see only the documents visible to you.
Sources
A source syncs documents from an integration, such as Notion or Confluence. Connect the integration under Integrations first. Each source reads as a worker, so that worker's grants and policies apply to every read. A source shows Idle, Syncing or Error; select Sync now to sync it.
Synonyms
Synonyms help search find words with the same meaning.
Who can do what
Only owners and admins manage sources and synonyms, and delete documents.
From the help article Documents, checked against the product on .
What you can do
The operations this feature's screens call. Each one is POST /api/<name>, and the badge says who may call it.
ViewerlistDocumentsLists documents.
Types:
ListDocumentsRequestreturnsPageResponse<DocumentSummaryDto>
ViewerlistSourcesLists sources.
Types:
EmptyRequestreturnsListResponse<KnowledgeSourceDto>
ViewersearchKnowledgeSearches knowledge.
Types:
SearchKnowledgeRequestreturnsListResponse<KnowledgeHitDto>
MembercreateDocumentCreates a document.
Types:
CreateDocumentRequestreturnsCreateDocumentResponse
ViewergetDocumentGets the document.
Types:
GetDocumentRequestreturnsDocumentDto
ViewerlistDocumentRevisionsLists document revisions.
Types:
ListDocumentRevisionsRequestreturnsListDocumentRevisionsResponse
MemberupdateDocumentUpdates the document.
Types:
UpdateDocumentRequestreturnsUpdateDocumentResponse
ViewergetDocumentRevisionGets the document revision.
Types:
GetDocumentRevisionRequestreturnsDocumentRevisionDto
AdmindeleteDocumentRemoves the document and its chunks from search; the audit log keeps the record of it and of the removal.
Types:
DeleteDocumentRequestreturnsOkResponse
ViewerlistIntegrationsLists integrations.
Types:
EmptyRequestreturnsListResponse<IntegrationDto>
ViewerlistConnectorsLists connectors.
Types:
EmptyRequestreturnsListResponse<ConnectorDto>
AdminsyncSourceSyncs the source.
Types:
SyncSourceRequestreturnsQueuedResponse
AdmincreateSourceCreates a source.
Types:
CreateSourceRequestreturnsKnowledgeSourceDto
ViewerlistSearchSynonymsThe org's search synonyms: pairs learned from its own org-wide text or set by people, and the built-in pairs every org starts with.
Types:
EmptyRequestreturnsListSearchSynonymsResult
AdminsetSearchSynonymAdds a search synonym pair for the org, or turns one off (a learned or built-in one included). Recall and knowledge search expand the term to the alternative and back.
Types:
SetSearchSynonymInputreturnsSearchSynonymDto
ViewerlistDocumentCommentsLists document comments.
Types:
ListDocumentCommentsRequestreturnsListDocumentCommentsResponse
MembercreateDocumentCommentCreates a document comment.
Types:
CreateDocumentCommentRequestreturnsCreateDocumentCommentResponse
MemberdeleteDocumentCommentDeletes the document comment.
Types:
DeleteDocumentCommentRequestreturnsOkResponse
ViewerlistMembersLists members.
Types:
EmptyRequestreturnsListMembersResponse
Screens
What it records
The feature writes these events to the audit log, the permanent record of what happened.
- Integration changed
- Memory written