canvas.document.get

query read

Use when current canvas state is missing from the task context.

Before calling

• Authenticate as the accountable Enhance person.
• Use only resource identifiers returned by an earlier capability result or supplied by the person.

Input

{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"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)$"},"afterVersion":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}},"required":["canvasId"]}

Example

{
 "canvasId": "00000000-0000-4000-8000-000000000010"
}

Result

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

• mutations: Returned field mutations.
• version (required): Returned field version.
• restoreFenceVersion: Returned field restoreFenceVersion.
• document (required): Returned field document.
• screens (required): Returned field screens.

Show complete result JSON Schema (JSON file)

Example result

{
 "version": 1,
 "document": {},
 "screens": []
}

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

• Use the returned identifiers and version in the next canvas operation.

Versions

Compatibility: cf3672abb3b78cdedd014e173c705353a89be466d0beeb536b00b5920b51eb97.

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