Skip navigation

Skip to main content

API reference

Asset

getTemporaryUrl findFonts openColorSelector requestFontSelection upload

Design

addAudioTrack addElementAtCursor addElementAtPoint addNativeElement addPage bulkCreate.launch createRichtextRange editContent getCurrentPageContext getDefaultPageDimensions getDesignMetadata getDesignToken initAppElement openDesign overlay.registerOnCanOpen publish.launch requestExport selection.registerOnChange setCurrentPageBackground ui.startDragToCursor ui.startDragToPoint ui.startDrag

Intents: Asset

prepareUrlExpander

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

User

auth.getCanvaUserToken auth.initOauth

bulkCreate.launch

API reference for the bulkCreate.launch method.

This version of the API is a preview. Preview APIs are unstable and may change without warning. You can't release public apps using this API until it's stable.

Launches the design bulk create with the data connector intent.

Usage: Launch the bulk create panel with the same app

import { bulkCreate } from "@canva/design";
import { features } from "@canva/platform";

if (features.isSupported(bulkCreate.launch)) {
  await bulkCreate.launch({ withDataConnector: 'self' });
}

TYPESCRIPT

Parameters

optsLaunchBulkCreateOpts

Required

Options for configuring the bulk create panel.

withDataConnectorstring

Required

The option to make sure the data connector intent of the current app will be triggered.

The only valid value is "self".

Returns

Promise<void>

Throws

unsupported_surface code if not invoked by the design editor intent.