Document apiReferenceClipboard

clipboard.parse

Parse and sanitize a ClipboardPayload into a deterministic v2 clipboard insert plan with diagnostics. Does not mutate the document.

read-onlyidempotent
doc.clipboard.parse(…)

Expected result

Returns a ClipboardParseResult with a ClipboardInsertPlan or a named fail-closed reason.

Inputs

itemsobject[]required
1 additional input field
sourcestring

Result

Output fields
successboolean
planobject
diagnosticsunknown[]
failureobject

Failures

Non-applied receipt codes

  • INVALID_INPUT
  • INVALID_PAYLOAD
  • EMPTY_FRAGMENT
3 more codes
  • CAPABILITY_UNSUPPORTED
  • INVALID_FRAGMENT
  • 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