enhancedocs
For agentsOpen Enhance ↗
Reference / recording.snapshot

Enhance documentation

recording.snapshot

Persist one visually accepted recording moment as an editable canvas screen.

↓ Markdown

recording.snapshot

mutation write

Use when the requested change exactly matches recording.snapshot; 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":{"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)$"},"recordingId":{"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)$"},"atMs":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Visually reviewed recording timestamp to persist, in milliseconds."},"timeoutMs":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991,"description":"Local snapshot polling deadline in milliseconds."}},"required":["canvasId","recordingId","atMs","timeoutMs"]}

Example

Show example input 
{
 "canvasId": "00000000-0000-4000-8000-000000000010",
 "recordingId": "00000000-0000-4000-8000-000000000010",
 "atMs": 1000,
 "timeoutMs": 120000
}

Result

Returns a typed recording.snapshot result from the Enhance API without transport-specific prose.

  • jobId (required): Returned field jobId.
  • canvasId (required): Returned field canvasId.
  • screenId (required): Returned field screenId.
  • screenNodeId (required): Returned field screenNodeId.
  • version (required): Returned field version.
  • retryClientToken (required): Returned field retryClientToken.
  • next (required): Returned field next.
Show complete result JSON Schema 
{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"jobId":{"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)$"},"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)$"},"screenId":{"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)$"},"screenNodeId":{"type":"string","minLength":1},"version":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"retryClientToken":{"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)$"},"next":{"type":"array","items":{"type":"string"}}},"required":["jobId","canvasId","screenId","screenNodeId","version","retryClientToken","next"],"additionalProperties":{}}

Example result

Show example result 
{
 "jobId": "00000000-0000-4000-8000-000000000010",
 "canvasId": "00000000-0000-4000-8000-000000000010",
 "screenId": "00000000-0000-4000-8000-000000000010",
 "screenNodeId": "screen_ready",
 "version": 2,
 "retryClientToken": "00000000-0000-4000-8000-000000000010",
 "next": [
  "Render the screen."
 ]
}

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 recording resource to confirm the result.

Versions

Compatibility: 0b80f40c3c7366bfca3d8fa5696dd07d42ebc8ae9e6cf41938b2ed0670b099b1.

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