Reference/Operations
Operations
Every operation of protocol v1. The TypeScript client and the .NET binding expose each one as a typed method.
Commands · 33
Commands write. Each is atomic, and a retried commit with the same attempt id applies once.
axis.defineDeclares an additional time axis, such as reading order next to story order.commitWrites one event with its records and transitions, atomically: all of it or nothing.commitBatchWrites several commits in one transaction.disposition.setBatchSets many Dispositions at once: how holders stand toward others, along named dimensions.embedding.defineSpaceDeclares an embedding space: where the vectors of one model live.embedding.deleteRemoves the vectors of some documents from a space.embedding.dropSpaceRemoves an embedding space and every vector in it.embedding.putStores vectors made by your model, or replaces them, in one transaction.entity.archiveMarks an entity as archived.entity.createCreates an entity of a declared type: a character, a group, a place, an object.entity.ensureBatchRegisters entities by your own ids: creates the missing ones and updates the others, in one transaction.entity.updateChanges an entity’s name, aliases, fields or external reference.entityType.createDeclares a kind of entity, its fields, and whether its entities can hold knowledge.evidence.registerRegisters a source, such as a document or a recording, that events and Holdings can cite.holding.adjustBatchChanges the confidence, accessibility or attitude of many Holdings at once, such as a night of forgetting.predicate.defineDeclares a predicate before claims use it: what its object is, and how many values a subject may have.project.createCreates a project inside the file. Projects are isolated from each other.proposal.applyApplies the accepted operations of a proposal as one commit.proposal.rebaseChecks which operations of a pending proposal still fit the current head of its timeline. Nothing is applied.proposal.rejectRejects a whole pending proposal, with a rationale.proposal.reviewAccepts or rejects operations of a pending proposal, each with a rationale.proposeHolds a commit for review instead of applying it.shutdownEnds a umwelt serve session cleanly: the file is checkpointed, the answer is sent, and the process exits.timeline.discardCloses a draft without promoting it. It stays readable by its id, and invisible to every other read.timeline.openDraftOpens a draft: a timeline apart from main, or from another draft, that sees its parent as it is now.timeline.promotePromotes a draft into its parent: all of its work becomes part of the parent at once.timeline.purgeRemoves every row of a discarded draft. Confirmed history is never deleted.timeline.rebaseReplays an active draft on top of its parent’s current head.transition.batchMoves many records to one status at once: retracted, revoked, forgotten or abandoned.transmitOne holder tells another something they hold, honestly or deceptively.transmitBatchSeveral tellings in one transaction, such as a conversation.witnessEveryone at a scene sees the same claims: one commit, one Holding per witness and claim.world.ensureDeclares a world in one call: the project and its entity types, entities, predicates and axes. It creates what is missing and leaves the rest as it is.Queries · 37
Queries read at a position and a version, and never see anything later.
axis.listEvery additional time axis of a project.beliefsAboutWhat one holder thinks another knows, set against what the other really holds.breachesEvery time a secret was told to someone outside the circle it was shared with.canonThe Facts visible at a position: the narrator’s read of what is true.changesAn append-only feed of what was written, to react to new commits.check.utteranceChecks claims a holder says or thinks against what they hold, and tells canon apart.claim.keyThe stable keys of a claim, computed by the engine.compareWhat two holders hold side by side: what they share, what only one holds and where they disagree.context.admitDecides which records and events may enter a context for a perspective, within a budget, with a reason for every refusal.contradictionsA holder’s beliefs that contradict canon or each other. They are reported, never corrected.dispositionsHow a holder stands toward others at a position: their current Dispositions, optionally toward one target or along one dimension.embedding.listSpacesEvery embedding space of a project.embedding.pendingThe searchable documents whose vector in a space is missing or out of date, with the exact text to embed.entity.asKnownByWhat a holder knows about an entity, under the names they were told.entity.atAn entity as canon names it at a position: its name, title and aliases over time.entity.getOne entity by its id, as stored.entity.listEvery entity of a project, archived ones included, by id.entity.resolveFinds an entity by the id another system gives it.entity.resolveBatchFinds many entities by the ids another system gives them.entityType.listEvery entity type of a project.evidence.getOne evidence source by its id.groupCoverageWho in a group holds a claim, who holds nothing about it, and whether the group itself does.holdingsWhat a holder holds at a position, one page at a time, with how each Holding was acquired.holdsDoes a holder hold a claim at a position? The answer comes with the Holding behind it.perspectiveEverything a holder holds, is aware of and feels at a position: their whole point of view in one read.predicate.listEvery predicate of a project, the reserved ones included.project.getOne project, with its current version.project.listEvery project in the file.proposal.getOne proposal, with its content and its reviews.proposal.listEvery proposal of a project, whatever its status.recordOne record by its id: a Fact, a Holding, an Awareness or a Disposition.searchFinds Facts, Holdings with text and events by their words, their meaning or both, within what the read can see.timelineThe events visible at a position, in story order, one page at a time.timeline.getOne timeline: main or a draft, with its parent, versions and status.timeline.listEvery timeline of a project, main first.traceHow a record came to be: its event, its transitions, and every link of who told whom, back to the source.whoHoldsEveryone who holds a claim at a position, believers of the opposite included.Was this page helpful?