enhancedocs
For agentsOpen Enhance ↗
Reference / canvas.create

Enhance documentation

canvas.create

Create a canvas and return the id required by canvas-scoped commands.

↓ Markdown

canvas.create

mutation write

Use when the requested change exactly matches canvas.create; 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":{"title":{"type":"string","minLength":1},"organisationId":{"default":null,"anyOf":[{"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)$"},{"type":"null"}]},"sourceUrl":{"default":null,"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["title"]}

Example

Show example input 
{
 "title": "x"
}

Result

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

  • id (required): Returned field id.
  • title (required): Returned field title.
  • accessState (required): Returned field accessState.
  • organisationId (required): Returned field organisationId.
  • sourceUrl (required): Returned field sourceUrl.
  • unresolvedCount (required): Returned field unresolvedCount.
  • viewerCan (required): Returned field viewerCan.
  • createdAt (required): Returned field createdAt.
  • lastActivityAt (required): Returned field lastActivityAt.
  • version (required): Returned field version.
Show complete result JSON Schema 
{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"id":{"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)$"},"title":{"type":"string","minLength":1},"accessState":{"type":"string","enum":["invite-only","link-view","link-comment","link-edit"]},"organisationId":{"anyOf":[{"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)$"},{"type":"null"}]},"sourceUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"unresolvedCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"viewerCan":{"type":"object","properties":{"read":{"type":"boolean"},"comment":{"type":"string","enum":["yes","sign-in","no"]},"edit":{"default":"no","type":"string","enum":["yes","sign-in","no"]},"grants":{"default":[],"type":"array","items":{"type":"object","properties":{"source":{"type":"string","enum":["direct","team","link"]},"accessLevel":{"type":"string","enum":["owner","can-edit","can-comment","can-view"]}},"required":["source","accessLevel"],"additionalProperties":false}},"grantableAccessLevels":{"default":[],"type":"array","items":{"type":"string","enum":["can-edit","can-comment","can-view"]}},"share":{"type":"boolean"},"manage":{"type":"boolean"},"readHistory":{"default":false,"type":"boolean"}},"required":["read","comment","edit","grants","grantableAccessLevels","share","manage","readHistory"],"additionalProperties":false},"createdAt":{"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))$"},"lastActivityAt":{"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))$"},"version":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}},"required":["id","title","accessState","organisationId","sourceUrl","unresolvedCount","viewerCan","createdAt","lastActivityAt","version"],"additionalProperties":false}

Example result

Show example result 
{
 "id": "00000000-0000-4000-8000-000000000010",
 "title": "x",
 "accessState": "invite-only",
 "organisationId": "00000000-0000-4000-8000-000000000010",
 "sourceUrl": "x",
 "unresolvedCount": 0,
 "viewerCan": {
  "read": false,
  "comment": "yes",
  "edit": "no",
  "grants": [],
  "grantableAccessLevels": [],
  "share": false,
  "manage": false,
  "readHistory": false
 },
 "createdAt": "2026-08-10T00:00:00.000Z",
 "lastActivityAt": "2026-08-10T00:00:00.000Z",
 "version": 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: 05e2c42ae4413ed89859edfd4c45cfa617afde60f030a0f62a490b0b106b5329.

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