enhancedocs
For agentsOpen Enhance ↗
Reference / canvas.remove

Enhance documentation

canvas.remove

Remove explicitly named subtrees atomically, preserving locked content and link scope.

↓ Markdown

canvas.remove

mutation write

Use when the requested change exactly matches canvas.remove; read the current state first when a version or identifier may have changed.

Before calling

  • Authenticate as the accountable Enhance person.
  • Use only resource identifiers returned by an earlier capability result or supplied by the person.
  • Reuse clientToken only when retrying this exact mutation input.

Input

Show complete JSON Schema 
{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"canvasRef":{"type":"string","minLength":1},"baseVersion":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"rootNodeIds":{"minItems":1,"type":"array","items":{"type":"string","minLength":1}}},"required":["canvasRef","baseVersion","rootNodeIds"],"additionalProperties":false}

Example

Show example input 
{
 "canvasRef": "00000000-0000-4000-8000-000000000010",
 "baseVersion": 1,
 "rootNodeIds": [
  "obsolete"
 ]
}

Result

Returns a typed canvas.remove result from the Enhance API without transport-specific prose.

Show complete result JSON Schema 
{"$schema":"https://json-schema.org/draft/2020-12/schema","oneOf":[{"type":"object","properties":{"outcome":{"type":"string","const":"no_op"},"canvasId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"version":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"verification":{"type":"object","properties":{"rendered":{"type":"boolean","const":false}},"required":["rendered"],"additionalProperties":false},"warnings":{"type":"array","items":{"type":"string"}}},"required":["outcome","canvasId","version","verification","warnings"],"additionalProperties":false},{"type":"object","properties":{"outcome":{"type":"string","const":"committed"},"canvasId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"mutationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"previousVersion":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"version":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"operation":{"type":"object","properties":{"kind":{"type":"string","const":"canvas-mutation"},"canvasId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"mutationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"fingerprint":{"type":"string","pattern":"^[a-f0-9]{64}$"}},"required":["kind","canvasId","mutationId","fingerprint"],"additionalProperties":false},"identities":{"type":"object","properties":{"entries":{"type":"array","items":{"type":"object","properties":{"sourceNodeId":{"type":"string","minLength":1},"nodeId":{"type":"string","minLength":1}},"required":["sourceNodeId","nodeId"],"additionalProperties":false}},"complete":{"type":"boolean"},"total":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["entries","complete","total"],"additionalProperties":false},"affected":{"type":"object","properties":{"insertedNodeIds":{"type":"array","items":{"type":"string","minLength":1}},"changedNodeIds":{"type":"array","items":{"type":"string","minLength":1}},"removedNodeIds":{"type":"array","items":{"type":"string","minLength":1}},"complete":{"type":"boolean"},"total":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["insertedNodeIds","changedNodeIds","removedNodeIds","complete","total"],"additionalProperties":false},"verification":{"type":"object","properties":{"rendered":{"type":"boolean","const":false}},"required":["rendered"],"additionalProperties":false},"warnings":{"type":"array","items":{"type":"string"}}},"required":["outcome","canvasId","mutationId","previousVersion","version","operation","affected","verification","warnings"],"additionalProperties":false}],"type":"object"}

Example result

Show example result 
{
 "outcome": "committed",
 "canvasId": "00000000-0000-4000-8000-000000000010",
 "mutationId": "00000000-0000-4000-8000-000000000010",
 "previousVersion": 1,
 "version": 2,
 "operation": {
  "kind": "canvas-mutation",
  "canvasId": "00000000-0000-4000-8000-000000000010",
  "mutationId": "00000000-0000-4000-8000-000000000010",
  "fingerprint": "ad9a89368fd01a87f81eabda0255669e2d562b4dfdf1b3aa0ceb58cd92b729c1"
 },
 "affected": {
  "insertedNodeIds": [],
  "changedNodeIds": [],
  "removedNodeIds": [
   "obsolete"
  ],
  "complete": true,
  "total": 1
 },
 "verification": {
  "rendered": false
 },
 "warnings": []
}

Recovery

  • BAD_REQUEST: correct the named fields and call again.
  • UNAUTHORIZED: restore Enhance authentication, then retry once.
  • FORBIDDEN or NOT_FOUND: check the supplied resource and selection; do not substitute unrelated content. Ask for corrected access or scope if needed.
  • CONFLICT: read the current resource, merge the intended change, and retry with its version.
  • INTERNAL: run Enhance diagnostics, report the failure, and stop repeating the call.

Continue with

  • Read the affected canvas resource to confirm the result.

Versions

Compatibility: c10d8f1284be6558f0b446dbfa9d4dc3d10530427705d5764c34d7db85733c78.

Minimum tested versions: Enhance CLI and MCP runtime 0.1.40, plugin 1.0.38, Node.js 24. No older floor is published.