Skip to main content
API reference sections

Schema

RunContextItem

One item of context, pinned.

The workspace travels with every item because content lives in exactly one workspace and a document id alone cannot say which room to open (DATAMODEL, content lives in exactly one workspace).

Type object or object or object

Shape

One of 3 shapes:

  1. kind: "document"

    A whole document at one captured version.

    FieldTypeDescription
    workspacerequiredWorkspaceId
    documentrequiredDocumentId

    DocumentId - a client-minted v4 UUID, hyphenated and lowercase. Immutable, and never derived from a name or a path.

    versionrequiredDocumentVersionId

    DocumentVersionId - a client-minted v4 UUID, hyphenated and lowercase. Immutable, and never derived from a name or a path.

    kindrequired"document"
  2. kind: "block"

    One block of a document, at one captured version of that document. The version is the document's - a block has no history of its own.

    FieldTypeDescription
    workspacerequiredWorkspaceId
    documentrequiredDocumentId

    DocumentId - a client-minted v4 UUID, hyphenated and lowercase. Immutable, and never derived from a name or a path.

    versionrequiredDocumentVersionId

    DocumentVersionId - a client-minted v4 UUID, hyphenated and lowercase. Immutable, and never derived from a name or a path.

    noderequiredBlockNodeId
    kindrequired"block"
  3. kind: "blob"

    A file, image or PDF from the content-addressed blob store, pinned at its hash. Retention is asserted at capture (§7.2 step 2).

    FieldTypeDescription
    workspacerequiredWorkspaceId
    blobrequiredBlobHash

    <algorithm>:<digest> - b3:<64 hex>.

    The algorithm is in the value because a hash that does not say what it is cannot be migrated: adopting a second one has to be additive, or every document already written is orphaned.

    blob_kindrequiredBlobKind

    What kind of bytes a blob item carries. The kind decides how the item is materialized for the provider (P1.7); the hash decides what it is.

    kindrequired"blob"
Example
{
  "workspace": "00000000-0000-4000-8000-000000000000",
  "document": "00000000-0000-4000-8000-000000000000",
  "version": "00000000-0000-4000-8000-000000000000",
  "kind": "document"
}

The contract has no example values, so example bodies are generated from each schema: every field is shown with a placeholder of its type.

Generated from contract version 1. Last updated .

Privacy choices

Choose which optional tools Koru may use on this site. Your choice is saved in a cookie in this browser for 12 months. Privacy policy

Privacy choices

Keep you signed in, protect forms and remember your language and this choice.

Always on

PostHog and Google Analytics 4 measure page views and actions such as downloads, using cookies or local storage.

PostHog records how pages are used, with form inputs masked and private pages excluded. Needs Analytics.

Ahrefs Web Analytics measures visits and where they come from, and Google Ads measures whether our ads led to a visit or download.