enhancedocs
For agentsOpen Enhance ↗
Reference / canvas.realtime.activity.begin

Enhance documentation

canvas.realtime.activity.begin

Show that this agent has started work on a canvas.

↓ Markdown

canvas.realtime.activity.begin

mutation write

Use when the requested change exactly matches canvas.realtime.activity.begin; 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)$"},"phase":{"type":"string","enum":["reading","writing","creating","deleting","rendering"]},"nodeIds":{"default":[],"maxItems":100,"type":"array","items":{"type":"string","minLength":1}},"bounds":{"default":null,"anyOf":[{"type":"object","properties":{"x":{"type":"number"},"y":{"type":"number"},"width":{"type":"number","exclusiveMinimum":0},"height":{"type":"number","exclusiveMinimum":0}},"required":["x","y","width","height"]},{"type":"null"}]}},"required":["canvasId","phase"]}

Example

Show example input 
{
 "canvasId": "00000000-0000-4000-8000-000000000010",
 "phase": "reading"
}

Result

Returns a typed canvas.realtime.activity.begin result from the Enhance API without transport-specific prose.

  • activityId (required): Returned field activityId.
  • expiresAt (required): Returned field expiresAt.
  • renewAfterMs (required): Returned field renewAfterMs.
Show complete result JSON Schema 
{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"activityId":{"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)$"},"expiresAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"renewAfterMs":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}},"required":["activityId","expiresAt","renewAfterMs"],"additionalProperties":false}

Example result

Show example result 
{
 "activityId": "00000000-0000-4000-8000-000000000010",
 "expiresAt": "2026-08-10T00:00:00.000Z",
 "renewAfterMs": 1
}

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: e85f092e0b861c5cb92c85529e826cc1147b44e8196a823b88ee890463072c61.

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