API reference

Asset

getTemporaryUrl findFonts openColorSelector requestFontSelection upload

Design

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

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

API reference

getTemporaryUrl

API reference for the getTemporaryUrl 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.

Retrieves a temporary URL that points to an asset in Canva's backend.

Usage

Get the URL of an uploaded image asset

import { type ImageRef, getTemporaryUrl } from "@canva/asset";

const placeholderImageRef = "PLACEHOLDER_IMAGE_REF" as ImageRef;

const result = await getTemporaryUrl({
  type: "image",
  ref: placeholderImageRef
});

TYPESCRIPT

Get the URL of an uploaded video asset

import { type VideoRef, getTemporaryUrl } from "@canva/asset";

const placeholderVideoRef = "PLACEHOLDER_VIDEO_REF" as VideoRef;

const result = await getTemporaryUrl({
  type: "video",
  ref: placeholderVideoRef
});

TYPESCRIPT

Parameters

optionsGetTemporaryUrlOptions

Required

Options for retrieving a temporary URL that points to an asset in Canva's backend.

Options for retrieving a temporary URL that points to an image asset in Canva's backend.

typestring

Required

The type of asset.

The only valid value is "image".

refImageRef

Required

A unique identifier that points to an image asset in Canva's backend.

Options for retrieving a temporary URL that points to a video asset in Canva's backend.

typestring

Required

The type of asset.

The only valid value is "video".

refVideoRef

Required

A unique identifier that points to a video asset in Canva's backend.

Returns

The result of retrieving a temporary URL of an asset in Canva's backend. This is a Promise that resolves with the following object:

The result of retrieving a temporary URL of an image asset in Canva's backend.

typestring

The type of asset.

The only valid value is "image".

refImageRef

A unique identifier that points to an image asset in Canva's backend.

urlstring

A temporary URL for downloading the asset.

The result of retrieving a temporary URL of a video asset in Canva's backend.

typestring

The type of asset.

The only valid value is "video".

refVideoRef

A unique identifier that points to a video asset in Canva's backend.

urlstring

A temporary URL for downloading the asset.