Document apiReferenceChanges

changes.get

Get one retained change record by id.

read-onlyidempotent
await doc.changes.get(…)

Expected result

Returns the ChangeRecord with that id, or null when this session does not retain it.

Inputs

idstringrequired

Result

Output fields
id
idstringrequired

Deterministic id: identical transactions yield identical ids in every session.

seqintegerrequired
revisionstringrequired
origin"local" | "remote"required
actorobject | nullrequired
id
idstring | nullrequired
namestring
emailstring
claimstring

Application-supplied identity claim. SuperDoc does not verify it.

Variant 2

No fields.

contributorsobject[]
actorType"human" | "code" | nullrequired
Variant 1

No fields.

Variant 2

No fields.

cause"user" | "api" | "undo" | "redo" | nullrequired
Variant 1

No fields.

Variant 2

No fields.

provenance"authored" | "declared" | "relayed" | "unknown"required
atobjectrequired
Fields
declaredstring | nullrequired
observedstringrequired
sessionobjectrequired
Fields
idstring | nullrequired
clientIdintegerrequired
changeTagstring
changestext | format | paragraph | split | merge | move | create | remove | table | sidecar[]required
updatestring

Base64 Yjs v1 update for exactly this transaction.

Variant 2

No fields.

Failures

Pre-apply throws

  • INVALID_INPUT
  • CAPABILITY_UNAVAILABLE

Raw schemas

Open the generated JSON artifact for the exact input, output, success, and failure schemas represented by this contract version.

View raw JSON schemas