getTemporaryUrl

API reference for the getTemporaryUrl method.

Gets the URL of an asset, such as an image or video file, from Canva's backend.

To see how this method is used, see Replacing elements.

import { getTemporaryUrl } from "@canva/asset";
(async () => {
const result = await getTemporaryUrl({
type: "IMAGE",
ref: "<REFERENCE_GOES_HERE>",
});
console.log(result.url);
})();
ts

Before an app that uses this method can be submitted for review, the canva:asset:private:read permission must be enabled via the Developer Portal. To learn more, see Configuring permissions.

This method has a rate limit of 20 requests every 10 seconds.

#optionsobject
Required

The options for getting the URL of an asset.

#options.typestring
Required

The type of asset.

The available options include:

  • "IMAGE"
  • "VIDEO"
#options.refstring
Required

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

A Promise that resolves with the following object:

#resultobject
Required

The successful result of getting a temporary URL.

#result.typestring
Required

The type of asset.

The possible values include:

  • "IMAGE"
  • "VIDEO"
#result.refstring
Required

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

#result.urlstring
Required

The URL of the asset.