The Canva Apps SDK, Connect APIs, and MCP are now unified in the Canva Developers SDK. Learn more(opens in a new tab or window).
Canva Developers SDK
The Canva Apps SDK, Connect APIs, and MCP are now unified in the Canva Developers SDK. Learn more(opens in a new tab or window).

getTemporaryUrl

API reference for the getTemporaryUrl method.

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

Download and re-upload as a derived asset

import { type ImageRef, getTemporaryUrl, upload } from "@canva/asset";
const originalImageRef = "PLACEHOLDER_IMAGE_REF" as ImageRef;
// Get the temporary URL for the original image
const { url } = await getTemporaryUrl({
type: "image",
ref: originalImageRef
});
// Process the image (e.g., apply effects)
const processedImageUrl = await processImage(url);
// Upload the processed image with parentRef pointing to the original
await upload({
type: "image",
parentRef: originalImageRef,
url: processedImageUrl,
mimeType: "image/jpeg",
thumbnailUrl: processedImageUrl,
// If you used AI to process the image, set this to "app_generated"
aiDisclosure: "none"
});
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.