---
description: Unofficial Capacitor plugin for Cloudinary SDK to upload files directly from the filesystem to Cloudinary.
title: Capacitor Cloudinary Plugin for Android, iOS & Web - Capawesome
image: https://capawesome.io/docs/assets/images/social/plugins/cloudinary.png
---
[ Skip to content](#capawesomecapacitor-cloudinary)
[ π Introducing **Capawesome Platform** β one platform for Live Updates, Native Builds, App Store Publishing, and Insider SDKs.](https://capawesome.io)
* [ Configuration ](#configuration)
* [ Demo ](#demo)
* [ Usage ](#usage)
* [ API ](#api)
* [ Enums ](#enums)
* [ Utils ](#utils)
* [ Changelog ](#changelog)
* [ License ](#license)
* [ Credits ](#credits)
* [ Contacts ](/docs/plugins/contacts/)
* [ Datetime Picker ](/docs/plugins/datetime-picker/)
* [ File Compressor ](/docs/plugins/file-compressor/)
* [ File Opener ](/docs/plugins/file-opener/)
* [ File Picker ](/docs/plugins/file-picker/)
* [ Firebase ](/docs/plugins/firebase/)
* [ Formbricks ](/docs/plugins/formbricks/)
* [ Geocoder ](/docs/plugins/geocoder/)
* [ Google Sign-In ](/docs/plugins/google-sign-in/)
* [ libSQL ](/docs/plugins/libsql/)
* [ Live Update ](/docs/plugins/live-update/)
* [ Managed Configurations ](/docs/plugins/managed-configurations/)
* [ Media Session ](/docs/plugins/media-session/)
* [ ML Kit ](/docs/plugins/mlkit/)
* [ NFC ](/docs/plugins/nfc/)
* [ OAuth ](/docs/plugins/oauth/)
* [ Pedometer ](/docs/plugins/pedometer/)
* [ Photo Editor ](/docs/plugins/photo-editor/)
* [ PostHog ](/docs/plugins/posthog/)
* [ Printer ](/docs/plugins/printer/)
* [ Purchases ](/docs/plugins/purchases/)
* [ RealtimeKit ](/docs/plugins/realtimekit/)
* [ Screen Orientation ](/docs/plugins/screen-orientation/)
* [ Screenshot ](/docs/plugins/screenshot/)
* [ Secure Preferences ](/docs/plugins/secure-preferences/)
* [ Speech Recognition ](/docs/plugins/speech-recognition/)
* [ Speech Synthesis ](/docs/plugins/speech-synthesis/)
* [ Share Target ](/docs/plugins/share-target/)
* [ Square Mobile Payments ](/docs/plugins/square-mobile-payments/)
* [ SQLite ](/docs/plugins/sqlite/)
* [ Superwall ](/docs/plugins/superwall/)
* [ Torch ](/docs/plugins/torch/)
* [ Wifi ](/docs/plugins/wifi/)
* [ Zip ](/docs/plugins/zip/)
* [ Cloud ](/docs/cloud/)
* [ Live Updates ](/docs/cloud/live-updates/)
* Advanced
* Integrations
* [ Native Builds ](/docs/cloud/native-builds/)
* [ Configuration ](/docs/cloud/native-builds/configuration/)
* [ Environments ](/docs/cloud/native-builds/environments/)
* Guides
* [ Sample Projects ](/docs/cloud/native-builds/sample-projects/)
* [ Troubleshooting ](/docs/cloud/native-builds/troubleshooting/)
* [ Automations ](/docs/cloud/automations/)
* [ Assist ](/docs/cloud/assist/)
* Account
* Organizations
* [ Organization and User Management ](/docs/cloud/organizations/memberships/)
* [ Single Sign-On (SSO) ](/docs/cloud/organizations/sso/)
* [ Teams ](/docs/cloud/organizations/teams/)
* [ Two-Factor Authentication ](/docs/cloud/organizations/two-factor-authentication/)
* [ Integrations ](/docs/cloud/integrations/)
* [ License Keys ](/docs/cloud/license-keys/)
* [ Webhooks ](/docs/cloud/webhooks/)
* [ Pricing ](https://capawesome.io/pricing/)
* [ FAQ ](/docs/cloud/faq/)
* [ Support ](/docs/cloud/support/)
* [ Contributing ](/docs/contributing/)
* [ LLMs ](/docs/llms/)
* [ Insiders ](/docs/insiders/)
* [ License ](https://capawesome.io/legal/eula/)
* [ Support ](/docs/insiders/support/)
* [ FAQ ](/docs/insiders/faq/)
* [ Blog ](/blog/)
* Categories
* [ Configuration ](#configuration)
* [ Demo ](#demo)
* [ Usage ](#usage)
* [ API ](#api)
* [ Enums ](#enums)
* [ Utils ](#utils)
* [ Changelog ](#changelog)
* [ License ](#license)
* [ Credits ](#credits)
# @capawesome/capacitor-cloudinary[ΒΆ](#capawesomecapacitor-cloudinary "Permanent link")
Unofficial Capacitor plugin for [Cloudinary SDK](https://cloudinary.com/documentation/cloudinary%5Fsdks).[1](#fn:1)
[  ](https://cloud.capawesome.io/)
## Features[ΒΆ](#features "Permanent link")
Capacitor Cloudinary allows you to use the native Cloudinary SDKs to upload files directly from the filesystem without going through the WebView.
* π Supports Android, iOS and the Web
* π Chunk upload of large files
* β No more out-of-memory issues
* π Works with the [Capacitor Filesystem](https://capacitorjs.com/docs/apis/filesystem) and [Capacitor File Picker](https://github.com/capawesome-team/capacitor-file-picker)
## Newsletter[ΒΆ](#newsletter "Permanent link")
Stay up to date with the latest news and updates about the Capawesome, Capacitor, and Ionic ecosystem by subscribing to our [Capawesome Newsletter](https://cloud.capawesome.io/newsletter/).
## Compatibility[ΒΆ](#compatibility "Permanent link")
| Plugin Version | Capacitor Version | Status |
| -------------- | ----------------- | -------------- |
| 8.x.x | \>=8.x.x | Active support |
| 7.x.x | 7.x.x | Deprecated |
| 6.x.x | 6.x.x | Deprecated |
| 5.x.x | 5.x.x | Deprecated |
## Installation[ΒΆ](#installation "Permanent link")
You can use our **AI-Assisted Setup** to install the plugin. Add the [Capawesome Skills](https://github.com/capawesome-team/skills) to your AI tool using the following command:
`[](#%5F%5Fcodelineno-0-1)npx skills add capawesome-team/skills --skill capacitor-plugins
`
Then use the following prompt:
`` [](#%5F%5Fcodelineno-1-1) Use the `capacitor-plugins` skill from `capawesome-team/skills` to install the `@capawesome/capacitor-cloudinary` plugin in my project.
``
If you prefer **Manual Setup**, install the plugin by running the following commands and follow the platform-specific instructions below:
`[](#%5F%5Fcodelineno-2-1)npm install @capawesome/capacitor-cloudinary
[](#%5F%5Fcodelineno-2-2)npx cap sync
`
### Android[ΒΆ](#android "Permanent link")
This API requires the following permission be added to your `AndroidManifest.xml` **before** the `application` tag:
`[](#%5F%5Fcodelineno-3-1)
`
You also need to add the following receiver **inside** the `application` tag in your `AndroidManifest.xml`:
`[](#%5F%5Fcodelineno-4-1)
[](#%5F%5Fcodelineno-4-2)
[](#%5F%5Fcodelineno-4-3)
[](#%5F%5Fcodelineno-4-4)
[](#%5F%5Fcodelineno-4-5)
`
#### Variables[ΒΆ](#variables "Permanent link")
If needed, you can define the following project variable in your appβs `variables.gradle` file to change the default version of the dependency:
* `$cloudinaryAndroidVersion` version of `com.cloudinary:cloudinary-android` (default: `3.1.2`)
This can be useful if you encounter dependency conflicts with other plugins in your project.
## Configuration[ΒΆ](#configuration "Permanent link")
No configuration required for this plugin.
## Demo[ΒΆ](#demo "Permanent link")
A working example can be found here: [robingenz/capacitor-plugin-demo](https://github.com/robingenz/capacitor-plugin-demo)
## Usage[ΒΆ](#usage "Permanent link")
`[](#%5F%5Fcodelineno-5-1)import { Cloudinary, ResourceType } from '@capawesome/capacitor-cloudinary';
[](#%5F%5Fcodelineno-5-2)
[](#%5F%5Fcodelineno-5-3)const initialize = async () => {
[](#%5F%5Fcodelineno-5-4) await Cloudinary.initialize({ cloudName: 'my_cloud_name' });
[](#%5F%5Fcodelineno-5-5)};
[](#%5F%5Fcodelineno-5-6)
[](#%5F%5Fcodelineno-5-7)const uploadResource = async () => {
[](#%5F%5Fcodelineno-5-8) await Cloudinary.uploadResource({
[](#%5F%5Fcodelineno-5-9) path: 'file:///var/mobile/Containers/Data/Application/22A433FD-D82D-4989-8BE6-9FC49DEA20BB/Images/test.png',
[](#%5F%5Fcodelineno-5-10) publicId: 'my_public_id',
[](#%5F%5Fcodelineno-5-11) resourceType: ResourceType.image,
[](#%5F%5Fcodelineno-5-12) uploadPreset: 'my_preset',
[](#%5F%5Fcodelineno-5-13) });
[](#%5F%5Fcodelineno-5-14)};
[](#%5F%5Fcodelineno-5-15)
[](#%5F%5Fcodelineno-5-16)const downloadResource = async () => {
[](#%5F%5Fcodelineno-5-17) const { path } = await Cloudinary.downloadResource({
[](#%5F%5Fcodelineno-5-18) url: 'https://res.cloudinary.com/myCloudName/image/upload/v123/123.png',
[](#%5F%5Fcodelineno-5-19) });
[](#%5F%5Fcodelineno-5-20) return path;
[](#%5F%5Fcodelineno-5-21)};
`
## API[ΒΆ](#api "Permanent link")
* [initialize(...)](#initialize)
* [uploadResource(...)](#uploadresource)
* [downloadResource(...)](#downloadresource)
* [Interfaces](#interfaces)
* [Enums](#enums)
### initialize(...)[ΒΆ](#initialize "Permanent link")
`[](#%5F%5Fcodelineno-6-1)initialize(options: InitializeOptions) => Promise
`
Initialize the plugin.
This method must be called once before all other methods.
| Param | Type |
| ----------- | --------------------------------------- |
| **options** | [InitializeOptions](#initializeoptions) |
**Since:** 0.0.1
---
### uploadResource(...)[ΒΆ](#uploadresource "Permanent link")
`[](#%5F%5Fcodelineno-7-1)uploadResource(options: UploadResourceOptions) => Promise
`
Upload a file to Cloudinary.
**Note**: Currently, only unsigned uploads are supported.
| Param | Type |
| ----------- | ----------------------------------------------- |
| **options** | [UploadResourceOptions](#uploadresourceoptions) |
**Returns:** `Promise<[UploadResourceResult](#uploadresourceresult)>`
**Since:** 0.0.1
---
### downloadResource(...)[ΒΆ](#downloadresource "Permanent link")
`[](#%5F%5Fcodelineno-8-1)downloadResource(options: DownloadResourceOptions) => Promise
`
Download a file from Cloudinary.
On **Android**, the file will be downloaded to the `Downloads` directory. On **iOS**, the file will be downloaded to the temporary directory.
It is recommended to copy the file to a permanent location for further processing after downloading.
| Param | Type |
| ----------- | --------------------------------------------------- |
| **options** | [DownloadResourceOptions](#downloadresourceoptions) |
**Returns:** `Promise<[DownloadResourceResult](#downloadresourceresult)>`
**Since:** 0.0.3
---
### Interfaces[ΒΆ](#interfaces "Permanent link")
#### InitializeOptions[ΒΆ](#initializeoptions "Permanent link")
| Prop | Type | Description | Since |
| ------------- | ------ | ----------------------------------------------------------------------------------- | ----- |
| **cloudName** | string | The cloud name of your app which you can find in the Cloudinary Management Console. | 0.0.1 |
#### UploadResourceResult[ΒΆ](#uploadresourceresult "Permanent link")
| Prop | Type | Description | Since |
| -------------------- | ----------------------------- | ---------------------------------------------------------------------------------------- | ----- |
| **assetId** | string | The unique asset identifier of the uploaded resource. Only available on Android and Web. | 0.0.1 |
| **bytes** | number | The number of bytes of the uploaded resource. | 0.0.1 |
| **createdAt** | string | The timestamp at which the resource was uploaded. | 0.0.1 |
| **duration** | number | The duration of the uploaded resource in seconds. | 0.1.5 |
| **format** | string | The format of the uploaded resource. | 0.0.1 |
| **height** | number | The height of the uploaded resource. | 0.1.4 |
| **originalFilename** | string | The original filename of the uploaded resource. Only available on Android and iOS. | 0.0.1 |
| **resourceType** | [ResourceType](#resourcetype) | The resource type of the uploaded resource. | 0.0.1 |
| **publicId** | string | The unique public identifier of the uploaded resource. | 0.0.1 |
| **url** | string | The url of the uploaded resource. | 0.0.1 |
| **secureUrl** | string | The secure url of the uploaded resource. | 5.1.0 |
| **width** | number | The width of the uploaded resource. | 0.1.4 |
#### UploadResourceOptions[ΒΆ](#uploadresourceoptions "Permanent link")
| Prop | Type | Description | Since |
| ---------------- | ----------------------------- | ------------------------------------------------------------------ | ----- |
| **resourceType** | [ResourceType](#resourcetype) | The resource type to upload. | 0.0.1 |
| **blob** | Blob | The file to upload. Only available on Web. | 0.0.1 |
| **uploadPreset** | string | The selected upload preset. | 0.0.1 |
| **path** | string | The path of the file to upload. Only available on Android and iOS. | 0.0.1 |
| **publicId** | string | Assign a unique public identifier to the resource. | 0.0.1 |
#### DownloadResourceResult[ΒΆ](#downloadresourceresult "Permanent link")
| Prop | Type | Description | Since |
| -------- | ------ | -------------------------------------------------------------------------------------------------------- | ----- |
| **path** | string | The path of the downloaded resource where it is stored on the device. Only available on Android and iOS. | 0.0.3 |
| **blob** | Blob | The downloaded resource as a blob. Only available on Web. | 0.0.1 |
#### DownloadResourceOptions[ΒΆ](#downloadresourceoptions "Permanent link")
| Prop | Type | Description | Since |
| ------- | ------ | ------------------------------------ | ----- |
| **url** | string | The url of the resource to download. | 0.0.3 |
### Enums[ΒΆ](#enums "Permanent link")
#### ResourceType[ΒΆ](#resourcetype "Permanent link")
| Members | Value | Since |
| --------- | ------- | ----- |
| **Image** | 'image' | 0.0.1 |
| **Video** | 'video' | 0.0.1 |
| **Raw** | 'raw' | 0.0.1 |
## Utils[ΒΆ](#utils "Permanent link")
See [docs/utils/README.md](https://github.com/capawesome-team/capacitor-plugins/blob/main/packages/cloudinary/docs/utils/README.md).
## Changelog[ΒΆ](#changelog "Permanent link")
See [CHANGELOG.md](https://github.com/capawesome-team/capacitor-plugins/blob/main/packages/cloudinary/CHANGELOG.md).
## License[ΒΆ](#license "Permanent link")
See [LICENSE](https://github.com/capawesome-team/capacitor-plugins/blob/main/packages/cloudinary/LICENSE).
## Credits[ΒΆ](#credits "Permanent link")
This plugin is based on the [Capacitor Cloudinary](https://github.com/capawesome-team/capacitor-cloudinary) plugin. Thanks to everyone who contributed to the project!
---
1. This project is not affiliated with, endorsed by, sponsored by, or approved by Cloudinary Ltd. or any of their affiliates or subsidiaries. [β©](#fnref:1 "Jump back to footnote 1 in the text")
May 17, 2026
Back to top