Enhance documentation

enhance-dev canvas realtime activity begin

Show that this agent has started work on a canvas.

enhance-dev canvas realtime activity begin

enhance-dev canvas realtime activity begin [options]

Arguments

This command takes no positional arguments.

Options

Option	Required	Default	Meaning
`--canvas-id <string>`	Yes	None	Canvas id, from `enhance canvas list`.
`--phase <string>`	No	None	Agent work now in progress: reading, writing, creating, deleting, or rendering.
`--node-ids [values...]`	No	“	Stable canvas node ids affected by the current agent activity.
`--bounds [value]`	No	`null`	Optional world-space activity bounds as x, y, width, and height JSON.
`--json <json>`	No	None	Complete procedure input as JSON; do not combine it with field flags.
`--client-token <uuid>`	No	None	Stable UUID to reuse when retrying the exact same mutation.

Input

This command presents the capability canvas.realtime.activity.begin. It has write effect and single idempotency.

Show complete input 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"]}

Output

This command writes JSON records to standard output. Returns a typed canvas.realtime.activity.begin result from the Enhance API without transport-specific prose.

Show complete output 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}

Examples

enhance-dev canvas realtime activity begin --canvas-id <string>

Show example input

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

Show example output

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

Exit behaviour

Exit code	Meaning
`0`	The command succeeded.
`1`	The command failed for another reason (`INTERNAL`). A write may have an unknown outcome.
`2`	The command line was malformed. Nothing ran.
`3`	The API refused the input (`BAD_REQUEST`).
`4`	The credential is missing or expired (`UNAUTHORIZED`).
`5`	The API refused the request (`FORBIDDEN`, `NOT_FOUND`, `CONFLICT`, `RATE_LIMITED`).
`6`	A batch finished only in part. Retry with the same `--client-token`.

Versions

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