Skip navigation

Skip to main content

API reference

Asset

getTemporaryUrl findFonts openColorSelector requestFontSelection upload Changelog

Design

addAudioTrack addElementAtCursor addElementAtPoint addNativeElement

addPage bulkCreate.launch createRichtextRange editContent getCurrentPageContext getDefaultPageDimensions

getDesignMetadata getDesignTemplateMetadata getDesignToken initAppElement openDesign overlay.registerOnCanOpen publish.launch requestExport selection.registerOnChange setCurrentPageBackground ui.startDragToCursor ui.startDragToPoint ui.startDrag

Error

Intents

Intents: Content

prepareContentPublisher

Intents: data

prepareDataConnector

Intents: design

prepareDesignEditor

Platform

appProcess appProcess.broadcastMessage appProcess.current appProcess.current.getInfo appProcess.current.requestClose appProcess.current.setOnDispose appProcess.requestClose appProcess.registerOnMessage appProcess.registerOnStateChange features.isSupported features.registerOnSupportChange getPlatformInfo notification.addToast requestOpenExternalUrl Changelog

User

auth.getCanvaUserToken auth.initOauth monetization.isEnabled monetization.openTrackingSession monetization.requestEnableBillableAction Changelog

getDesignTemplateMetadata

API reference for the getDesignTemplateMetadata method.

Retrieves information about the template that was used in a design.

Usage: Get design template metadata

import { getDesignTemplateMetadata } from "@canva/design";

const templateMetadata = await getDesignTemplateMetadata();

const { keywords, domain } = templateMetadata;

TYPESCRIPT

Returns

Information about the template that was used in a design. This is a Promise that resolves with the following object:

templatesIterable<TemplateMetadata>

Optional

The templates applied to the pages within the design.

keywordsstring[]

A list of keywords contained in a template.

domainstring

Determines the domain of the template. This could be public, brand or personal.

Available values:

"public"
"brand"
"personal"