Canvases

Export a canvas

Exports the canvas as legacy MaskoAnimationConfig JSON by default, or as a target-specific delivery envelope with delivery=1. No credit cost.

get/v1/collections/{id}/canvases/{canvasId}/export

Request

  • Base URL: https://api.masko.ai
  • URL: https://api.masko.ai/v1/collections/{id}/canvases/{canvasId}/export
  • Auth: HTTP bearer

Path parameters

idstring uuid required
canvasIdstring uuid required

Query parameters

format'json'
delivery'1'

Return the delivery envelope instead of legacy MaskoAnimationConfig data.

target'macos' | 'windows' | 'web' | 'full'

Delivery media target. macos returns HEVC URLs, windows returns WebM URLs, web returns WebM and HEVC URLs, full returns all selected formats.

mode'selected' | 'manifest'

Delivery mode. selected returns one variant; manifest includes known variants.

sizeinteger

Selected delivery size in pixels, if that size variant has already been generated.

Response

Canvas export data

dataExportConfigData required

Changes

No recorded changes to this operation across all 1 revision of this API.