v1

latestOpenAPI 3.1.02026-07-223261135.0 KB

canvases

Make a canvas public

Create a public share link for a canvas. Anyone with the link can view the canvas. By default, the request blocks until a thumbnail has been generated so the share URL will unfurl properly when shared on social media or messaging platforms. Set wait_for_thumbnail=false to return immediately.

post/canvases/{canvas_id}/share

Path parameters

canvas_idstring required

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.

Example:cvs_01HT9WK8N3M2J4A5Z6P7Q8R9TV

Headers

Moda-Version'2026-04-12' | '2026-05-01'

Example: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.

Request body

permission'view' | 'view_remix'

Permission level for the share link. 'view' allows anyone with the link to view the canvas. 'view_remix' (default) allows anyone to view and create a remix copy of the canvas.

wait_for_thumbnailboolean

If true (default), the request blocks until the canvas thumbnail has been generated. This ensures the share URL will unfurl properly with a preview image when shared on social media or messaging platforms. If false, returns immediately after making the canvas public (thumbnail generation runs in the background).

thumbnail_timeout_secondsinteger

Maximum seconds to wait for thumbnail generation when wait_for_thumbnail=true. If the timeout is reached, the response is returned with thumbnail_ready=false. Min 1, max 120. Ignored when wait_for_thumbnail=false.

Response

Successful Response

share_urlstring required

Public URL for viewing the canvas. Share this link to give anyone view access.

share_tokenstring required

Unique token identifying this share link.

public_enabledboolean required

Whether public access is currently enabled.

permissionstring required

Permission level: 'view' (view only) or 'view_remix' (view and remix).

thumbnail_readyboolean required

Whether the canvas thumbnail is available. When true, the share URL will show a preview image when unfurled. When false, a generic preview may be shown instead.