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,
   "maxLength": 200
  },
  "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",
     "maxLength": 2048
    },
    {
     "type": "null"
    }
   ]
  }
 },
 "required": [
  "title",
  "organisationId",
  "sourceUrl"
 ],
 "additionalProperties": false
}

Example

Show example input 
{
 "title": "x",
 "organisationId": null,
 "sourceUrl": null
}

Result

Returns a typed canvas.create 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: 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.

Compatibility: 63a7238867ecd394639c7a69b4b83f22323ce55ceba4b62fffbf5e3e3e163c44.