API reference
Asset: Test
Design
addAudioTrackaddElementAtCursoraddElementAtPointaddPageapplyTemplateautofillDesignbulkCreate.launchcreateRichtextRangeduplicatePageeditContentgetBrandKitColorsgetBrandTemplateMetadatagetCurrentPageContextgetCurrentPageMetadatagetDesignColorsgetDesignMetadatagetDesignTemplateMetadatagetDesignTokeninitAppElementopenDesignoverlay.registerOnCanOpenpublish.launchrequestApplyPublicTemplaterequestBrandTemplatesrequestDataFieldMatchingrequestExportselection.registerOnChangesetCurrentPageBackgroundsetDataFieldLabelVisibilityui.startDragToCursorui.startDragToPointChangelog
Design: Test
Intents
Intents: Asset
Intents: Content
Intents: Data
Intents: Design
Intents: Test
Platform
appProcessappProcess.broadcastMessageappProcess.currentappProcess.current.getInfoappProcess.current.requestCloseappProcess.current.setOnDisposeappProcess.requestCloseappProcess.registerOnMessageappProcess.registerOnStateChangefeatures.isSupportedfeatures.registerOnSupportChangegetPlatformInfonotification.addToastrequestOpenExternalUrlChangelog
Platform: Test
User: Test
App middleware: Express
Error
Error: Test
Changelog for @canva/intents@beta
The latest changes for the Canva Apps SDK @canva/intents@beta package.
2.7.2-beta.0 - 2026-09-22
Added
- Adds a new field contentNoun to content publisher intent, which controls the copy of the publish button. Leaving it empty defaults it to type 'content' (generic). Consumers should set this appropriately and prepare for the deprecation of custom overrides (the current method of changing the publish button copy).
- Added
MediaSlotWithAutoSelect, so an app can ask Canva to pre-select every valid input for a media slot when the publish panel first opens.
2.6.1-beta.1 - 2026-07-23
Added
DataTablemedia cells can now carry references to already-imported Canva media (image_reference/video_reference), in addition to the existingimage_upload/video_uploadvariants. This lets aDataTableretrieved viarequestDataTable(which returns already-imported Data Connector media) be passed torequestAutofillDesignandrequestDataFieldMatchingwithout losing its images and videos.- Add
requestDataTableto retrieve aDataTablefrom a Data Connector, either through the data preview selection (dataSelectionDisplay: 'show') or directly from a data source reference (dataSelectionDisplay: 'hide'). DataConnectorIntent.getDataTablecan now returnDataTablemedia cells containing references to already-imported Canva media (image_reference/video_reference), matching the media cell shapes already returned byrequestDataTable.
2.6.1-beta.0 - 2026-06-18
Added
- Added
content_exportto theContentNountype in the content publisher intent
2.5.1-beta.2 - 2026-05-28
Added
- Add multi-page document preview support to Content Publisher
- Add optional
contentNounon Content PublisherOutputTypeso apps can describe what kind of content is published (for example post, email, or publication) and Canva can tailor publish-flow UX accordingly. When omitted, behavior defaults to genericcontent. - Add
getContentSummaryaction to the Content Publisher
2.5.1-beta.1 - 2026-05-12
Added
- Promote requestAiContent from alpha to beta
2.5.1-beta.0 - 2026-04-10
Changed
- Promotion intents from preview to ga
2.4.1-beta.0 - 2026-03-30
Added
- Added
Selection,ImageSelection,VideoSelection,DocumentSelection, andEmailSelectiontypes representing metadata about user-selected media in a media slot - Added optional
selectionfield toMediaSlot, populated by Canva when returning output types in Settings UI contexts
2.2.1-beta.1 - 2026-02-27
Fixed
- Beta PreviewMedia and Preview types now correctly use full EmailPreview variants throughout RenderPreviewUiRequest, PublishPreviewUiInvocationContext, and ContentPublisherIntent.
2.2.1-beta.0 - 2026-02-24
Added
- Added new html_standalone publish format for single html files
2.1.3-beta.0 - 2026-02-03
Added
- Added a CHANGELOG.md to track changes
- Breaking: Added enhanced error handling between
publishContentand theSettingsUi - Added a new
PublishErrorClearedSettingsUiContextfor when the UI clears an error - Include design title in content metadata for the content publisher intent
- Added
html_bundlesupport in content publisher for email media slots - Added
InvoctationContextto provide initial state for content publisher intent - Promoted the email requirements in content publisher from alpha to beta
Fixed
- Fixed the
initTestEnvironmentAPI not mocking some intents
2.0.2-beta.3 - 2025-11-11
- Initial changelog for the Preview Intents SDK.