Create Canvas
Create a canvas — blank pages, or a one-call copy of a team template.
Returns page ids + editor URL + revision. With template_canvas_id set,
the new canvas is a full copy of that source canvas (every page, node, and
variable; description, category, and theme carried over; the source’s brand
kit kept — brand consistency is the point of team templates) instead of
blank pages — the same copy seam the in-app agent’s
create_canvas(mode="copy_canvas") uses. The copy never inherits the
source’s template flag, and name replaces the default copy naming.
Discover the team’s flagged templates (with thumbnails) via
GET /v1/templates. A missing, deleted, or cross-team source is a 404
not_found; a source whose collaboration state is still syncing is a
retryable 503 canvas_crdt_state_not_ready.
Honors idempotency_key through the shared pipeline: a retried create
replays the stored result instead of minting a second canvas; the same key
with a different payload is a 409 idempotency_conflict.
Create-specific key semantics (deliberate, documented on the field):
- Replay is CLIENT-KEY-ONLY. Without a key every call creates a new canvas; the server never derives a replay key from the payload (same-args creates from different sessions are distinct intents).
- A replayed create is UNMISTAKABLY loud:
replayed: trueplusreused_existing: true, the ORIGINALcreated_at, and a steeringnote— never a barecommitted— because the replayed canvas may have been authored since, and a caller that treats it as a fresh blank canvas would author over existing content. - A stored result whose canvas was DELETED since does not replay: the
stale record is invalidated and the create re-executes fresh (loud
stale_replay_invalidatedmarker), minting a NEW canvas.
Authorizations
API key from Settings > Developer > REST API
Headers
Calendar-dated API version pin. New integrations should pin 2026-05-01 to opt into the newest response shapes. For back-compat the server also accepts requests with no header and resolves them to the current default (today: 2026-04-12); that default advances on each sunset date. Any unsupported value returns 400 unsupported_version.
2026-04-12, 2026-05-01 "2026-05-01"
Body
Canvas display name.
1 - 300Page width in px.
x <= 10000Page height in px.
x <= 10000Number of blank pages.
1 <= x <= 100Canvas category (slides, social, carousel, pdf, diagram, ui, animation, prints, web-ads, other). Drives slides/motion semantics and export defaults. Omit to let the server infer.
Prefixed cvs_ wire ID (Crockford base32 body) — the canonical, recommended form. For back-compat, a bare UUID string is also accepted in both path parameters and JSON request bodies (older integrations that stored raw UUIDs keep working). Both are permanent, supported inputs.
^cvs_[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$"cvs_01HT9WK8N3M2J4A5Z6P7Q8R9TV"
Prefixed fld_ wire ID (Crockford base32 body) — the canonical, recommended form. For back-compat, a bare UUID string is also accepted in both path parameters and JSON request bodies (older integrations that stored raw UUIDs keep working). Both are permanent, supported inputs.
^fld_[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$"fld_01HT9WK8N3M2J4A5Z6P7Q8R9TV"
Explicit visibility for the new canvas: private hides it from teammates; team makes it visible to the whole team. Ignored in favor of the folder's visibility when folder_id is set. Omit for the workspace default.
team, private A retried create with the same key replays the stored result (replayed:true + reused_existing:true + the original created_at) instead of creating a second canvas. Replay is CLIENT-KEY-ONLY: omit the key and every call creates a NEW canvas — the server never derives a key from the payload. Never derive this key from the payload yourself (e.g. a hash of name+dimensions): same-args creates are legitimately distinct intents, and a payload-derived key reused from a later session returns the ORIGINAL (possibly authored) canvas instead of a new one. Use a fresh random key per intended create; reuse it only to retry that same create.
200Response
Successful Response
The response is of type Response Canvasactionscreate · object.