HistoryEntry

Type object

Shape

Field	Type	Description
idrequired	HistoryEntryId	HistoryEntryId - a client-minted v4 UUID, hyphenated and lowercase. Immutable, and never derived from a name or a path.
documentrequired	DocumentId	DocumentId - a client-minted v4 UUID, hyphenated and lowercase. Immutable, and never derived from a name or a path.
versionrequired	DocumentVersionId	DocumentVersionId - a client-minted v4 UUID, hyphenated and lowercase. Immutable, and never derived from a name or a path.
reasonrequired	string
recorded_atrequired	integer (int64)
label	string or null	Default `null`
message	string or null	Default `null`
boundary	string or null	Default `null`
pinnedrequired	boolean

Example

{
  "id": "00000000-0000-4000-8000-000000000000",
  "document": "00000000-0000-4000-8000-000000000000",
  "version": "00000000-0000-4000-8000-000000000000",
  "reason": "string",
  "recorded_at": 0,
  "label": "string",
  "message": "string",
  "boundary": "string",
  "pinned": false
}

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

Used by

POST/v1/workspaces/{id}/documents/{document}/history
Capture a durable document version and append a history marker
POST/v1/workspaces/{id}/history/{entry}/label
Rename a history marker; its immutable state is untouched

Generated from contract version 1. Last updated November 12, 2026.