Document apiReferenceClipboard

clipboard.insert

Insert a parsed clipboard plan, v2 fragment, or raw ClipboardPayload through the v2 pasteFragment kernel operation.

mutates documenttracked modedry runnon-idempotent
doc.clipboard.insert(…)

Expected result

Returns a ClipboardInsertResult with inserted refs, diagnostics, and one paste transaction receipt, or a named fail-closed reason.

Inputs

payloadobject
planobject
fragmentobject
targetobject
changeMode"direct" | "tracked"
fallback"reject-rich" | "plain-with-warning"

Result

Output fields
true
status"NO_OP"
changeTagstring

Caller correlation for this commit only; never persisted or replayed on Undo/Redo.

temporaryobject
Fields
idstringrequired
phase"begin" | "replace" | "rollback" | "commit"required
tagstringrequired
onNativeEdit"cancel" | "preserve"
cancelledBy"native-edit"
appliedChangeMode"direct" | "tracked"
idstring
insertedEntityAddress[]
updatedEntityAddress[]
removedEntityAddress[]
invalidatedRefsAffectedRef[]
remappedRefsAffectedRefRemapping[]
affectedStoriesStoryLocator[]
textRangeShiftsTextRangeShift[]
trackedTextRangeShiftsTrackedTextRangeShift[]
txIdstring
warningsReviewWarning[]
effectsReceiptEffects
Fields
insertedTextTextMutationEffect[]
insertedBlocksBlockMutationEffect[]
resultTextTextTarget
Fields
captureStatestring

Opaque browser selection capture state. Preserve it when passing a selection target to comments.create. Changed or unverifiable state is refused before writing.

kind"text"required
segmentsTextSegment[]required
storyStoryLocator

Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.

body
kind"story"required
storyType"body"required
headerFooterSlot
kind"story"required
storyType"headerFooterSlot"required
sectionSectionAddressrequired
headerFooterKind"header" | "footer"required
variant"default" | "first" | "even"required
resolution"effective" | "explicit"
onWrite"materializeIfInherited" | "editResolvedPart" | "error"
headerFooterPart
kind"story"required
storyType"headerFooterPart"required
refIdstringrequired
footnote
kind"story"required
storyType"footnote"required
noteIdstringrequired
endnote
kind"story"required
storyType"endnote"required
noteIdstringrequired
textbox
kind"story"required
storyType"textbox"required
textboxIdstringrequired
coordinateSpaceTextCoordinateSpace
trackedChangeRefsTrackedChangeAddress[]
trackedChangeCountinteger
changedboolean
successtruerequired
planobjectrequired
Fields
sourceKind"superdoc-v2-fragment" | "superdoc-v1-slice" | "html" | "rtf" | "image" | "file" | "plain-text" | "empty" | "unknown"required
blockCountintegerrequired
assetCountintegerrequired
imageRefCountintegerrequired
plainFallbackbooleanrequired
diagnosticsobject[]required
false
successfalserequired
failureobjectrequired
Fields
code"INVALID_INPUT" | "INVALID_TARGET" | "INVALID_PAYLOAD" | "EMPTY_FRAGMENT" | "INVALID_FRAGMENT" | "CAPABILITY_UNSUPPORTED" | "CAPABILITY_UNAVAILABLE" | "REVISION_MISMATCH" | "PRECONDITION_FAILED"required
messagestringrequired
detailsunknown

Failures

Pre-apply throws

  • TARGET_NOT_FOUND
  • INVALID_TARGET
  • INVALID_INPUT
1 more codes
  • CAPABILITY_UNAVAILABLE

Non-applied receipt codes

  • INVALID_INPUT
  • INVALID_TARGET
  • INVALID_PAYLOAD
6 more codes
  • EMPTY_FRAGMENT
  • INVALID_FRAGMENT
  • CAPABILITY_UNSUPPORTED
  • CAPABILITY_UNAVAILABLE
  • REVISION_MISMATCH
  • PRECONDITION_FAILED

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