Glossary
MarkdownThe terms these docs use, each defined in one sentence and linked to the page that explains it.
| Term | Definition | Explained in |
|---|---|---|
| Space | The boundary for permissions and paths, within which members, roles, and the file tree are kept, with one default Space per account. | Core concepts |
| Entry | The stable identity of a source, such as a file, a URL, or a piece of text. | Core concepts |
| Version | An immutable record of an Entry's content, made each time the content changes. | Core concepts |
| Knowledge state | The processing progress of an Entry, reported in knowledge.state. | Core concepts |
| Memory | A statement with a scope, a status, and a source, which is an account memory, a memory written as an Entry, or a fact distilled from an Entry. | Memory |
| Memory scope | What a memory belongs to: project is one Space, agent is one Agent, and account is the account. | Memory |
| Memory status | Where a memory stands in review: candidate, confirmed, rejected, or superseded. | Memory |
| Principal | The person (kind: human) or Agent (kind: agent) a request acts as; an API key belongs to a principal and is not one itself. | Permissions |
| Capability | Permission for one kind of operation, such as knowledge:read or knowledge:write. | Permissions |
| API key | The credential sent on every request as Authorization: Bearer mb_live_..., which can only narrow its principal. | Authentication and API keys |
| Agent | A principal of kind: agent, with its own permissions, memory, and audit identity. | Permissions |
| Context pack | What context returns for a task: sources the service picked and packed within a token budget, with its choices explained in route. | Retrieval and context |
| Citation | The [cN] id of one source in a context pack, which an answer uses to mark where a statement comes from. | Retrieval and context |
| Branch | A copy-on-write layer over a Space's main line, used as an Agent's workspace, whose paths become versions on main only when merged. | Branches and mounts |
| Checkpoint | A record of a branch's own changes at one moment, which the branch can roll back to. | Branches and mounts |
| Snapshot | A record of every file's path and version in a Space at one moment, which copies no bytes. | Sync, snapshots, and export |
| Proposal | A write an Agent submits for a file owned by someone else, which becomes a new version only when a reviewer approves it. | Files and versions |
| Job | Work that cannot finish within the request, which returns 202 with a job_id that you poll until the status is final. | API conventions |
| Read root | The read_root the Space owner sets on a member, which limits reads to that directory and returns 404 for paths outside it. | Permissions |
| Write root | The write_root the Space owner sets on a member, which limits writes to that directory. | Permissions |
| Idempotency key | The Idempotency-Key header on a write, which lets you send the write again without running it twice. | API conventions |
| Cursor | An opaque string a list or the change feed returns, used to read the next page or continue. | API conventions |
| ETag | The id of a file's latest version, used for conditional writes and reads. | API conventions |
| Offline consolidation | An optional deployment feature that tidies existing memories while no Agent is working, without generating new content; each run is called a dream in the API. | Memory |
Next steps
- Files and versions: start by writing a file.
- Permissions: how principals, capabilities, roles, and roots decide a request.
- API reference: the parameters and responses of every endpoint.
