Skip to main content
POST
Create Canvas

Authorizations

Authorization
string
header
required

API key from Settings > Developer > REST API

Headers

Moda-Version
enum<string>
default:2026-05-01

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.

Available options:
2026-04-12,
2026-05-01
Example:

"2026-05-01"

Body

application/json
name
string
required

Canvas display name.

Required string length: 1 - 300
width
integer
default:1920

Page width in px.

Required range: x <= 10000
height
integer
default:1080

Page height in px.

Required range: x <= 10000
page_count
integer
default:1

Number of blank pages.

Required range: 1 <= x <= 100
category
string | null

Canvas 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.

template_canvas_id
string | null

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.

Pattern: ^cvs_[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$
Example:

"cvs_01HT9WK8N3M2J4A5Z6P7Q8R9TV"

folder_id
string | null

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.

Pattern: ^fld_[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$
Example:

"fld_01HT9WK8N3M2J4A5Z6P7Q8R9TV"

visibility
enum<string> | null

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.

Available options:
team,
private
idempotency_key
string | null

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.

Maximum string length: 200

Response

Successful Response

The response is of type Response Canvasactionscreate · object.