Skip navigation

Skip to main content

API reference
Intents: design
API reference

requestExport

API reference for the requestExport method.

Exports the user's design as one or more static files.

Parameters

requestExportRequest
Required

The request object containing configurations of the design export.

acceptedFileTypesobject[]
Required

The types of files the user can export their design as.

You must provide at least one file type.

The types of files that Canva supports for exported designs.

Available values:

  • "png"
  • "jpg"
  • "pdf_standard"
  • "video"
  • "gif"
  • "pptx"
  • "svg"

Object representation of the supported file types with properties where applicable.

Supported image file types with properties.

Zip behavior for image file types:

  • auto (default): Files are zipped together if the design has multiple pages, unzipped if it has one page.
  • always: Files are always zipped into a single zip file, regardless of page count.
  • never: Files are never zipped, providing an array of files.
typestring
Required

Available values:

  • "png"
  • "jpg"
  • "svg"
zippedZipBehavior
Optional

The behavior of zipping the exported files.

For png, jpg, and svg:

  • auto (default): Files are zipped together if the design has multiple pages, unzipped if it has one page.
  • always: Files are always zipped into a single zip file, regardless of page count.
  • never: Files are never zipped, providing an array of files.

For video and gif:

  • auto or never (default): Files are never zipped together, regardless of count.
  • always: Files are always zipped into a single file.

Available values:

  • "auto"
  • "always"
  • "never"

Supported video file types with properties.

Zip behavior for video file types:

  • auto or never (default): Files are never zipped together, regardless of count.
  • always: Files are always zipped into a single file.
typestring
Required

Available values:

  • "gif"
  • "video"
zippedZipBehavior
Optional

The behavior of zipping the exported files.

For png, jpg, and svg:

  • auto (default): Files are zipped together if the design has multiple pages, unzipped if it has one page.
  • always: Files are always zipped into a single zip file, regardless of page count.
  • never: Files are never zipped, providing an array of files.

For video and gif:

  • auto or never (default): Files are never zipped together, regardless of count.
  • always: Files are always zipped into a single file.

Available values:

  • "auto"
  • "always"
  • "never"

Supported print file types.

typestring
Required

Available values:

  • "pdf_standard"
  • "pptx"

Returns

The result of exporting a design. This is a Promise that resolves with the following object:

The result when a user successfully completes an export flow.

statusstring

The status of the export flow.

The only valid value is "completed".

exportBlobsExportBlob[]

The exported files.

This array can contain a single link either to a file or a ZIP, or multiple links to individual files.

urlstring

The URL of the exported design.

If a user's design contains multiple pages but is exported in a format that doesn't support multiple pages, by default this URL will point to a ZIP file that contains each page as a separate file.

If the user has configured the export to not zip the exported files (using the zipped property), this URL will point to a single file.

For example:

  • If a single-page design is exported as a JPG, the URL will point to a JPG file.
  • If a multi-page design is exported as a JPG, the URL will point to a ZIP file that contains a JPG file for each page.
  • If a multi-page design is exported as a JPG and the user has set zipped to never for JPGs, the URL will point to a JPG file and will be one of multiple urls in the exportBlobs array.
  • If a multi-page design is exported as a PDF file, the URL will point to a PDF file.
  • If a multi-page design is exported as a VIDEO file and the user has set zipped to always for VIDEOs, the URL will point to a ZIP that contains a VIDEO file.

The following file types support multiple pages:

  • "GIF"
  • "PDF_STANDARD"
  • "PPTX"
  • "VIDEO"

The following file types do not support multiple pages:

  • "JPG"
  • "PNG"
  • "SVG"
titlestring
Optional

The title of the design, if set by the user.

The result when a user abandons the export flow, such as by closing the export menu.

statusstring

The status of the export flow.

The only valid value is "aborted".