enhancedocs
For agentsOpen Enhance ↗
Reference / canvas.makeEditable

Enhance documentation

canvas.makeEditable

Convert one captured screen into an independent editable copy beside its source, preserving the original.

↓ Markdown

canvas.makeEditable

mutation write

Use when the requested change exactly matches canvas.makeEditable; 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},"waitMs":{"default":1500,"description":"Additional polling after the initial server call; this does not bound initial compilation time.","type":"integer","minimum":0,"maximum":5000},"sourceNodeId":{"type":"string","minLength":1,"description":"One existing captured screen. The original remains unchanged."},"placement":{"type":"object","properties":{"kind":{"type":"string","const":"adjacent"}},"required":["kind"],"additionalProperties":false}},"required":["canvasRef","baseVersion","sourceNodeId","placement"],"additionalProperties":false}

Example

Show example input 
{
 "canvasRef": "00000000-0000-4000-8000-000000000010",
 "baseVersion": 1,
 "sourceNodeId": "screen",
 "placement": {
  "kind": "adjacent"
 },
 "waitMs": 1500
}

Result

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

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.

Compatibility: 3545bb34ee28f1b7ea13c09ac59d2d9dca11443cfc8482e6726432a934c15cd2.