Skip to content
Developer Preview

session/resume

Loads a stored session on this host, auto-subscribes this connection, and returns the history needed to render it.

Type: SessionResumeParams

session/resume params.

Field Type Stability Presence Description
approvalRules ClientApprovalRule[] Experimental optional Client-supplied shell prefix allow-rules override: omitted reinstalls the session’s rules from the audit fact, present replaces with that set (an explicit empty array clears). Explicit null is invalid params. Until the served-handler slice, a host refuses any spelled approvalRules on session/start/fork/resume with -32602; clients omit it. Experimental (session/resume.approvalRules).
commandId string required The idempotency handle (UUIDv7). A resume that loads a session writes a durable SessionResumed record.
config SessionConfig optional The same open construction-time extension object as session/start.
continuePausedSource ContinuePausedSource | null Experimental optional D7’s optional actor-bound explicit continuation object: the explicit user Resume action supplies it for a loaded paused source; absent or null keeps current resume behavior and does not release this feature’s loaded-source hold. Nullable (D7’s null-tolerant set). Standalone DTO (T-50280-074): the real effect is T-50280-084’s.
cursor string | null optional A view cursor previously observed by this client — or an observed summarizedThrough compaction anchor. When it names an event the server still holds, the server returns only the suffix and history.mode is none. A cursor the server minted that names no event yet, such as the empty start cursor of a session that had no events, is treated as no cursor: the server serves what a resume without a cursor would. A cursor older than the earliest event the server still holds gets a snapshot, or -32040 viewTruncated when none fits. A cursor this session’s view never minted is refused with -32011 notFound, reason missingAnchor, and a compaction anchor naming a boundary the server has pruned is refused with -32042 boundaryPruned. Omitted and explicit null both mean “no cursor”.
excludeItems boolean optional Return only session metadata and live resume state; page history separately with view/page. Default false.
history HistoryPreference optional History mode preference, default auto. A PREFERENCE, not a budget override: when the requested mode does not fit the history budget the server downgrades it and history.mode reports what was actually served. Ignored when cursor or excludeItems makes it moot.
missingInputAssets MissingInputAssets Experimental optional What a cold load does with a retained input image whose file is missing or corrupt. Omitted means fail; explicit null is invalid params. Only the resume that loads the session reads it; an attach ignores it. Experimental (session/resume.missingInputAssets).
modelId string optional The explicit MSP model override: a model string the caller supplies at resume time. When present it wins over the retained binding’s recorded origin — over a stamped label and over a stamped pin — and it recovers an otherwise-unresolved label binding by sending the override as the wire model instead of the unresolved refusal. Omitted preserves arm (2): the retained binding resolves by recorded origin exactly as without this member. Explicit null is invalid params (the same closed null-tolerant set as at start). The override changes the model within the retained provider; it never names a provider, and it never touches the retained profile.
permissionProfile string optional The launch permission-profile pick: a profile id the host catalog already admits. Select, never create. Omitted restores retained authority only, with no override. The host restores first, then applies the pick in the same pre-marker step; over a declared lost record the restore is the never-wider reset, committed before the pick, and where the reset cannot commit the pick is committed alone as that reset. A pick that fails admission refuses the resume commandRejected (-32030; permission_profile_unknown / permission_profile_unavailable) before any durable byte. Explicit null is invalid params (the same closed null-tolerant set as at start).
recoveryMode RecoveryMode optional Cold-resume replacement choice; omission preserves the retained choice. A warm attach rejects a different or unestablished choice as invalidParams. Explicit null is invalid.
sessionId string required The session to load.
Source

schema/msp/experimental/msp.schema.json#/methods/session~2Fresume

{
"description": "Loads a stored session on this host, auto-subscribes this connection, and returns the history needed to render it.",
"params": {
"$ref": "#/$defs/SessionResumeParams"
},
"result": {
"$ref": "#/$defs/SessionResumeResult"
}
}