Skip navigation

Skip to main content

API reference
API reference

getTemporaryUrl

API reference for the getTemporaryUrl method.
This version of the API is deprecated. This version will soon be unsupported. You should use a stable version of the API in your app.

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 Selection API.

Usage

import { getTemporaryUrl } from "@canva/asset";


const result = await getTemporaryUrl({
  type: "IMAGE",
  ref: "<REFERENCE_GOES_HERE>",
});


console.log(result.url);
TS

Scopes

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

Rate limit

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

Parameters

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.

Returns

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.

The URL is temporary and expires after a short duration. Your app should download the asset immediately rather than assuming the URL will continue to exist.