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"
  ],
  "additionalProperties": false
}

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.

Recovery

  • BAD_REQUEST: correct the named fields and call again.
  • UNAUTHORIZED: restore Enhance authentication, then retry once.
  • FORBIDDEN or NOT_FOUND: list accessible resources and choose an allowed identifier.
  • 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.

Compatibility: 1784317a952df45f31505039fba55ef2dbf0886956168216c514c87d155ee9b7.