Export Canvas
Export a canvas as PNG, JPEG, PDF, PPTX, MP4, or GIF. Returns a signed URL or a polling handle.
Exports require DB-level team access regardless of share-link status.
Share-link-only callers can read the canvas via GET /canvases/{id}
with a share_token query param but cannot export.
Large or slow exports (multi-page documents, mp4/gif animation renders)
may exceed the synchronous wait budget; in that case the response carries
status='in_progress' with a task_id — call
GET /canvases/{id}/export-status?task_id=... to retrieve the signed
URL once the background export finishes. Animation exports render one
page’s timeline server-side (silent MP4; page-timeline duration, capped
at 2000 frames / 120 s) and reject a page with nothing to animate with a
422 no_animation error.
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"
Path Parameters
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"
Query Parameters
Export format: png, jpeg, pdf, pptx, mp4, or gif. mp4/gif render a single page's animation timeline (server MP4s are silent) and require the page to actually carry animation — a still page is rejected with no_animation.
1-indexed page number to export. Omit to export all pages — PDF/PPTX bundle every page natively, while multi-page PNG/JPEG are returned as a .zip of per-page files (page-1.png, page-2.png, …) since a single image container can't hold multiple pages. format in the response reflects what was actually delivered (zip in the bundled case). mp4/gif export exactly one page: required on a multi-page canvas, defaulted to 1 on a single-page one.
x >= 1Render scale multiplier (1-4). Higher values produce sharper exports at larger file sizes. Supported for PNG, JPEG, PDF, MP4, and GIF exports (mp4/gif default to 1 — page resolution). PPTX ignores this parameter.
1 <= x <= 4PDF only: produce a raster-only PDF with no searchable text, vector elements, or hyperlinks.
When True (default), block up to ~20s for the export to finish before returning an in-progress handle. When False, return status='in_progress' with a task_id immediately — poll /canvases/{id}/export-status until terminal.
When False (default), reuse a cached export if the canvas is unchanged since it was rendered — fast, no browser render. Set True to force a fresh render.
Response
Successful Response
Response for POST /canvases/{id}/export.
Carries one of two shapes depending on status:
completed—urlis the signed download URL.in_progress—task_idlets the caller pollGET /canvases/{id}/export-status?task_id=...until terminal.
Prefixed canvas identifier for the canvas that was exported.
^cvs_[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$"cvs_01HT9WK8N3M2J4A5Z6P7Q8R9TV"
Full URL to open the source canvas in the Moda editor.
Delivered format — png, jpeg, pdf, pptx, mp4, gif, or zip. A multi-page PNG/JPEG export (page_number omitted, canvas has >1 page) is bundled into a .zip of per-page files, so format is zip even though the request asked for an image format.
completed when url is set, or in_progress when polling is required.
Signed download URL for the exported file (set when status='completed'). Expires in 7 days.
Export task ID set when status='in_progress'; poll the export-status endpoint with it.
Suggested poll interval when status='in_progress'.
Total page count for the source canvas (echoed for client convenience).
How the export was served: cache (existing artifact reused), slice (page extracted from a cached document, no render), or render (freshly rendered). null while status='in_progress'.
Quality caveats about the delivered file — empty when nothing was degraded. Set on status='completed' only (an in-progress response makes no claim yet); a cached or sliced artifact carries the same lane-level caveats as a freshly rendered one.