# @canva/asset

> The Canva Developers SDK asset management library for apps inside Canva

Latest version **2.3.0** (published 2025-12-22) · SEE LICENSE IN LICENSE.md FILE license · 0 weekly downloads

## Install

```sh
npm install @canva/asset
pnpm add @canva/asset
yarn add @canva/asset
bun add @canva/asset
```

## Health

**Score 45/100 (D)** — status: stable.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

## Facts

| | |
|---|---|
| Version | 2.3.0 |
| Published | 2025-12-22 |
| First published | 2023-11-17 |
| Weekly downloads | 0 |
| License | SEE LICENSE IN LICENSE.md FILE |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Canva Pty Ltd. |
| Maintainers | canva-dev |

## Links

- npm: https://www.npmjs.com/package/@canva/asset
- npm.io page: https://npm.io/package/@canva/asset

## Recent versions

- 2.3.0 (latest) — 2025-12-22
- 2.2.2 — 2025-12-10
- 2.2.1 — 2025-07-08
- 2.2.0 — 2025-04-01
- 2.1.0 — 2024-12-15
- 2.0.0 — 2024-09-19
- 1.7.1 — 2024-08-07
- 1.7.0 — 2024-07-23
- 1.6.0 — 2024-06-20
- 1.5.0 — 2024-04-02
- 1.4.0 — 2024-03-11
- 1.3.0 — 2024-02-25
- 1.2.0 — 2023-12-12
- 0.0.1-rc.22 — 2023-12-12
- 0.0.1-rc.21 — 2023-12-08
- … 20 more at https://npm.io/package/@canva/asset/versions

## README

# @canva/asset

A package for Canva's Apps SDK that provides methods for working with assets.

![](https://img.shields.io/badge/TypeScript-007ACC?style=for-the-badge&logo=typescript&logoColor=white)

## Table of contents

- [Introduction](#introduction)
- [Installation](#installation)
- [Usage](#usage)
- [API reference](#api-reference)
- [Related packages](#related-packages)
- [Contributing](#contributing)
- [License](#license)

## Introduction

`@canva/asset` is an npm package for Canva's [Apps SDK](https://www.canva.dev/docs/apps). It provides methods for working with assets, such as image and video files. For example, the package exports a `upload` method that uploads assets to the user's media library.

**Note:** To get up and running with the Apps SDK, check out [the quick start guide](https://www.canva.dev/docs/apps/quick-start).

## Installation

```bash
npm install @canva/asset
```

## Usage

1. Import a method or namespace from the `@canva/asset` package:

   ```ts
   import { upload } from '@canva/asset';
   ```

2. Call a method, passing in the required arguments (if any):

   ```ts
   await upload({
     type: 'IMAGE',
     id: 'uniqueIdGoesHere',
     mimeType: 'image/jpeg',
     url: 'https://www.canva.dev/example-assets/image-import/image.jpg',
     thumbnailUrl: 'https://www.canva.dev/example-assets/image-import/thumbnail.jpg',
   });
   ```

## API reference

- [`getTemporaryUrl`](https://www.canva.dev/docs/apps/api/asset-get-temporary-url)
- [`upload`](https://www.canva.dev/docs/apps/api/asset-upload)

## Related packages

The Apps SDK is made up of the following packages:

- [`@canva/app-ui-kit`](https://www.npmjs.com/package/@canva/app-ui-kit) - React-based component library for creating apps that mimic the look and feel of Canva.
- [`@canva/asset`](https://www.npmjs.com/package/@canva/asset) - Provides methods for working with assets, such as image and video files.
- [`@canva/design`](https://www.npmjs.com/package/@canva/design) - Provides methods for interacting with the user's design, such as creating elements.
- [`@canva/error`](https://www.npmjs.com/package/@canva/error) - Provides a `CanvaError` class for handling errors.
- [`@canva/platform`](https://www.npmjs.com/package/@canva/platform) - Provides utility methods, such as a method for opening external links.
- [`@canva/user`](https://www.npmjs.com/package/@canva/user) - Provides methods for accessing user data and authenticating users.

## Contributing

We're actively developing this package but are not currently accepting third-party contributions. If you'd like to request any changes or additions to the package, submit a feature request via the [Canva Developers Community](https://community.canva.dev/).

## License

See the `LICENSE.md` file.

---
_Source: https://npm.io/package/@canva/asset · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._