Skip to content

kaba.core

The Kaba SDK is the window.kaba object available to built-in pages: Kaba’s own apps and desktop widgets, served from kaba://. It is how the terminal, file explorer, Hippocampus and Settings talk to the client and the engine.

NamespacePurpose
kaba.coreData and engine: this page.
kaba.browserThe application: settings, windows, dialogs, updates.
kaba.viewsFrames and panes.
kaba.panesAttach to and drive another pane. See kaba.views.
kaba.omnibarShow, hide and load the omnibar.
kaba.downloadsThe downloads list and its events.
kaba.loggerQuery and stream the client log.
  • Every method returns a Promise unless noted as synchronous.
  • Methods that produce a stream of events return an EventTarget; use addEventListener.
  • Errors reject the promise with a named error.
  • Names are a mix of camelCase and snake_case; they are listed here exactly as they must be called.
// Who is signed in, with their settings
const account = await kaba.core.account();
// Fetch another site's data from a desktop widget, cached for ten minutes
const res = await kaba.core.widgetFetch('https://api.example.com/items', {
text: true,
cacheTtl: 600,
});
// The privacy policy currently in force
const policy = await kaba.core.privacyPolicy();

[todo: confirm argument lists and return shapes for the methods below against the source before publishing as a stable reference; this page lists names and purpose.]

MethodPurpose
account()The signed-in account, with its settings.
sessionId(), refreshSession()The current session.
updateUser()Change profile fields.
kabaControlServerAddress(), kabaApiInfo()Where the engine is listening.
kabaGetProfile(), kabaSetProfile()The training profile (who you are, tone).
MethodPurpose
settings()All settings.
get(), set()One value.
createSetting(), updateSetting(), deleteSetting()Manage a setting.
listThemes(), smartThemeTick()Themes.
getLanguage(), listLanguages(), getDictionary()Interface language.
MethodPurpose
list_memories(), memory_types()List and categorise.
search_memories()Semantic search.
add_memory(), save_memory(), delete_memory(), clear_memories()Create and remove.
list_version_memories(), memory_checksum_from_url()Versions of one page.
links_graph(), links_by_version_graph(), all_links_graph()Link graphs between memories.
kabaVoteMemory()Boost or suppress in training.
kabaListThoughts(), kabaThoughtsFor(), kabaSaveThought(), kabaDeleteThought(), kabaAttachThoughtFile(), kabaThoughtAttachmentData()Notes on memories.
kabaIgnoreDomain()Add to the Memory Ignore List.
list_custom_rules(), update_custom_rules(), delete_custom_rules()Extraction rules.
scrapeToMemory()Capture a URL as a memory.
MethodPurpose
addVisit(), getVisitHistory(), getMostVisited(), visitsSince(), search()History.
removeVisit(), removeAllVisits(), removeVisitsAfter()Delete history.
allFrames(), getFrame(), saveFrame(), updateFrame(), deleteFrame(), getFrameByLayout()Saved frames.

jobAll(), jobAdd(), jobGet(), jobUpdate(), jobRemove(), jobPause(), jobResume(), jobPauseAll(), jobResumeAll() manage the automations shown in Hippocampus.

MethodPurpose
kabaActivePolicy(), createPolicy(), updatePolicy(), deletePolicy(), setPolicy()Policies.
kabaListModels(), kabaModelVariants(), kabaImportModel(), kabaSelectModel(), kabaDeleteModel(), kabaModelDownload(), kabaImportCancel(), kabaPeerModelOp()Base models.
kabaListLoras(), kabaListLorasDetailed(), kabaListPeerLoras(), kabaImportLora(), kabaDeleteLora(), kabaUpdateLoraBase(), kabaPeerLoraOp()Adapters.
kabaEngineStatus(), kabaEngineControl(), kabaUnloadEngine(), aiReload(), aiUnload()The engine.
kabaTrain(), kabaEnrich()Local training and enrichment.
clusterTrainStart(), clusterEnrichStart(), clusterTrainPause(), clusterTrainResume(), clusterTrainStop(), clusterTrainStatus(), clusterTrainStateOf(), clusterTrainListCached(), clusterTrainMonitor()Training on a peer.
kabaUploadFile(), kabaListFiles(), kabaDeleteFile(), kabaClearFiles()Files attached to a conversation.
kabaResourceList(), kabaResourceRead(), kabaResourceWrite(), kabaResourceDelete()Policy resources such as flows.
kabaOntology(), kabaDecide(), kabaDecideStatus(), kabaDecideRelease(), tool_step()Tool-loop internals.

trajNav(), trajForm(), trajFileOp(), trajMemoryUse(), trajAgentRunStart(), trajAgentStep(), trajAgentRunEnd() record events. trajList(), listTrajectories(), trajDataset() read them. trajPurge() deletes them.

MethodPurpose
kabaListPeers(), clusterInvite(), clusterJoin(), clusterEvict(), clusterPing(), clusterSync(), deleteDevice()Membership.
clusterGetExit(), clusterSetExit()The exit node.
clusterPeerTerminalUrl()The address that opens a terminal on a peer.
folderStatus(), folderReconcile()Folder sync.
listExposedServices(), getExposedService(), createExposedService(), updateExposedService(), deleteExposedService(), rotateExposedServiceToken(), getServiceMetrics(), searchPublicServices(), refreshPublicServices()Exposed services.
MethodPurpose
fsHome(), fsList(), fsListMounts(), fsGetDirectory(), fsGetFile(), fsGetMetadata(), fsExists()Browse.
fsReadFile(), fsReadFileBase64(), fsStreamUrl()Read.
fsWriteFile(), fsWriteFileBase64(), fsMkdir(), fsCopy(), fsRename(), fsRemove()Write.
fsCompress(), fsDecompress()Archives.
fsWatchStart(), fsWatchStop()Watch for changes.
osOpenPath(), osShowInFolder(), osStartDrag()Hand off to the operating system.

sandboxExec() runs a command in the sandbox. sandboxImagesList(), sandboxImagesCatalog(), sandboxImagesPull(), sandboxImagesPullStatus(), sandboxImagesPrepull(), sandboxImagesRemove() manage images. sandboxContainersList(), sandboxContainersStop(), sandboxContainersDelete(), sandboxCleanup() manage containers. kabaLocalSupportsExec() reports whether this node can execute.

Covered in security & permissions: the privacy*, permission, tor*, securityIoc* and vault* methods.

MethodPurpose
widgetFetch(), widgetScrape()Fetch or read another site on behalf of a desktop widget.
geoLocate()Approximate location, for the weather widget and smart theme.
media(), mediaCommand()Media players on the machine.
importDetectBrowsers(), importPreview(), importRun(), importPasswordsCsv()Import from another browser.
getDiagnostics(), doctorProbe(), doctorReport(), doctorRepair(), resetChromeSettings(), paneHeapSnapshot(), debugCrumb()Diagnostics.
kabaTermStatus(), kabaTermRedact(), kabaTermTelemetry()Terminal recording status and redaction.