The SDK can be installed with either npm, pnpm, bun or yarn package managers.
npm add @cloudinary/assets
pnpm add @cloudinary/assets
bun add @cloudinary/assets
yarn add @cloudinary/assets zod
# Note that Yarn does not install peer dependencies automatically. You will need
# to install zod as shown above.
This SDK is also an installable MCP server where the various SDK methods are exposed as tools that can be invoked by AI applications.
Node.js v20 or greater is required to run the MCP server from npm.
Claude installation steps
Add the following server definition to your claude_desktop_config.json
file:
{
"mcpServers": {
"CloudinaryAssets": {
"command": "npx",
"args": [
"-y", "--package", "@cloudinary/assets",
"--",
"mcp", "start",
"--api-key", "...",
"--api-secret", "...",
"--cloud-name", "..."
]
}
}
}
Cursor installation steps
Create a .cursor/mcp.json
file in your project root with the following content:
{
"mcpServers": {
"CloudinaryAssets": {
"command": "npx",
"args": [
"-y", "--package", "@cloudinary/assets",
"--",
"mcp", "start",
"--api-key", "...",
"--api-secret", "...",
"--cloud-name", "..."
]
}
}
}
You can also run MCP servers as a standalone binary with no additional dependencies. You must pull these binaries from available Github releases:
curl -L -o mcp-server \
https://github.com/cloudinary/assets-js/releases/download/{tag}/mcp-server-bun-darwin-arm64 && \
chmod +x mcp-server
For a full list of server arguments, run:
npx -y --package @cloudinary/assets -- mcp start --help
For supported JavaScript runtimes, please consult RUNTIMES.md.
import { CloudinaryAssets } from "@cloudinary/assets";
const cloudinaryAssets = new CloudinaryAssets({
cloudName: "<value>",
security: {
apiKey: "CLOUDINARY_API_KEY",
apiSecret: "CLOUDINARY_API_SECRET",
},
});
async function run() {
const result = await cloudinaryAssets.upload.upload("auto", {
headers: "X-Robots-Tag: noindex",
moderation: "google_video_moderation",
rawConvert: "google_speech:vtt:en-US",
backgroundRemoval: "pixelz",
format: "jpg",
allowedFormats: "mp4,ogv,jpg,png,pdf",
autoTagging: 0.5,
detection: "coco_v2",
file: "", // Populate with string from file, for example example.file,
});
console.log(result);
}
run();
A parameter is configured globally. This parameter may be set on the SDK client instance itself during initialization. When configured as an option during SDK initialization, This global value will be used as the default on the operations that use it. When such operations are called, there is a place in each to override the global value, if needed.
For example, you can set cloud_name
to "<value>"
at SDK initialization and then you do not have to pass the same value on calls to operations like upload
. But if you want to do so you may, which will locally override the global setting. See the example code below for a demonstration.
The following global parameter is available. Global parameters can also be set via environment variable.
Name | Type | Description | Environment |
---|---|---|---|
cloudName | string | The cloud name of your product environment. | CLOUDINARY_CLOUD_NAME |
import { CloudinaryAssets } from "@cloudinary/assets";
const cloudinaryAssets = new CloudinaryAssets({
cloudName: "<value>",
security: {
apiKey: "CLOUDINARY_API_KEY",
apiSecret: "CLOUDINARY_API_SECRET",
},
});
async function run() {
const result = await cloudinaryAssets.upload.upload("auto", {
headers: "X-Robots-Tag: noindex",
moderation: "google_video_moderation",
rawConvert: "google_speech:vtt:en-US",
backgroundRemoval: "pixelz",
format: "jpg",
allowedFormats: "mp4,ogv,jpg,png,pdf",
autoTagging: 0.5,
detection: "coco_v2",
file: "", // Populate with string from file, for example example.file,
});
console.log(result);
}
run();
This SDK supports the following security scheme globally:
Name | Type | Scheme | Environment Variable |
---|---|---|---|
apiKey apiSecret |
http | Custom HTTP | CLOUDINARY_API_KEY CLOUDINARY_API_SECRET |
You can set the security parameters through the security
optional parameter when initializing the SDK client instance. For example:
import { CloudinaryAssets } from "@cloudinary/assets";
const cloudinaryAssets = new CloudinaryAssets({
security: {
apiKey: "CLOUDINARY_API_KEY",
apiSecret: "CLOUDINARY_API_SECRET",
},
cloudName: "<value>",
});
async function run() {
const result = await cloudinaryAssets.upload.upload("auto", {
headers: "X-Robots-Tag: noindex",
moderation: "google_video_moderation",
rawConvert: "google_speech:vtt:en-US",
backgroundRemoval: "pixelz",
format: "jpg",
allowedFormats: "mp4,ogv,jpg,png,pdf",
autoTagging: 0.5,
detection: "coco_v2",
file: "", // Populate with string from file, for example example.file,
});
console.log(result);
}
run();
Available methods
- createAssetRelationsByAssetId - Add related assets by asset ID
- deleteAssetRelationsByAssetId - Delete asset relations by asset ID
- createAssetRelationsByPublicId - Create asset relations by public ID
- deleteAssetRelationsByPublicId - Delete asset relations by public ID
- renameAsset - Updates an existing asset's identifier and optionally other metadata in your Cloudinary account
- downloadAsset - Generates a download link for a specific asset (image)
- explicitAsset - Apply operations on an existing asset
- generateArchive - Creates an archive (ZIP or TGZ file) that contains a set of assets from
- downloadBackupAsset - Download a backup copy of an asset
- destroyByAssetId - Delete asset by asset-id
- listResourceTypes - Get resource types
- listImages - Get image assets
- listVideos - Get video assets
- listRawFiles - Get raw assets
- listResourcesByAssetFolder - Get resources by asset folder
- listResourcesByAssetIDs - Get resources by asset IDs
- listResourcesByContext - Get resources by context
- listResourcesByModerationKindAndStatus - Get resources by moderation kind and status
- restoreResourcesByAssetIDs - Restore assets
- deleteResourcesByPublicId - Delete resources by public ID
- getResourceByPublicId - Get resource by public ID
- updateResourceByPublicId - Update asset by public ID
- getResourceByAssetId - Get resource by asset ID
- updateResourceByAssetId - Updates an existing asset's metadata, tags, and other attributes using its asset ID
- listResourceTags - Retrieves a list of tags currently applied to assets in your Cloudinary account
- deleteBackupVersions - Delete backed up versions
- derivedDestroy - Delete derived resources
- deleteBackupVersions - Delete backed up versions
- explodeResource - Create derived images from multi-page file
- showFolder - List sub-folders
- updateFolder - Renames or moves an entire folder (along with all assets it contains) to a
- createFolder - Creates a new empty folder in your Cloudinary media library
- destroyFolder - Deletes an existing folder from your media library
- listRootFolders - Get root folders
- searchFolders - Searches for folders whose attributes match a given expression
- searchFoldersPost - Searches for folders in your product environment
- listResourcesByModerationKindAndStatus - Get resources by moderation kind and status
- searchAssets - Provides a powerful query interface to filter and retrieve assets and their details
- visualSearchAssets - Finds images in your asset library based on visual similarity or content
- listResourceTags - Retrieves a list of tags currently applied to assets in your Cloudinary account
- upload - Uploads media assets (images, videos, raw files) to your Cloudinary product environment
- uploadChunk - Upload a single chunk of a large file
- destroyAsset - Destroys an asset/resource
- text - Create image from text
- getUsage - Retrieves comprehensive usage metrics and account statistics
- getVideoViews - Get video views
All the methods listed above are available as standalone functions. These functions are ideal for use in applications running in the browser, serverless runtimes or other environments where application bundle size is a primary concern. When using a bundler to build your application, all unused functionality will be either excluded from the final bundle or tree-shaken away.
To read more about standalone functions, check FUNCTIONS.md.
Available standalone functions
assetRelationsCreateAssetRelationsByAssetId
- Add related assets by asset IDassetRelationsCreateAssetRelationsByPublicId
- Create asset relations by public IDassetRelationsDeleteAssetRelationsByAssetId
- Delete asset relations by asset IDassetRelationsDeleteAssetRelationsByPublicId
- Delete asset relations by public IDassetsDeleteBackupVersions
- Delete backed up versionsassetsDeleteBackupVersions
- Delete backed up versionsassetsDeleteResourcesByPublicId
- Delete resources by public IDassetsDerivedDestroy
- Delete derived resourcesassetsDestroyByAssetId
- Delete asset by asset-idassetsDownloadAsset
- Generates a download link for a specific asset (image)assetsDownloadBackupAsset
- Download a backup copy of an assetassetsExplicitAsset
- Apply operations on an existing assetassetsGenerateArchive
- Creates an archive (ZIP or TGZ file) that contains a set of assets fromassetsGetResourceByAssetId
- Get resource by asset IDassetsGetResourceByPublicId
- Get resource by public IDassetsListImages
- Get image assetsassetsListRawFiles
- Get raw assetsassetsListResourcesByAssetFolder
- Get resources by asset folderassetsListResourcesByAssetIDs
- Get resources by asset IDsassetsListResourcesByContext
- Get resources by contextassetsListResourcesByModerationKindAndStatus
- Get resources by moderation kind and statusassetsListResourcesByModerationKindAndStatus
- Get resources by moderation kind and statusassetsListResourceTags
- Retrieves a list of tags currently applied to assets in your Cloudinary accountassetsListResourceTags
- Retrieves a list of tags currently applied to assets in your Cloudinary accountassetsListResourceTypes
- Get resource typesassetsListVideos
- Get video assetsassetsRenameAsset
- Updates an existing asset's identifier and optionally other metadata in your Cloudinary accountassetsRestoreResourcesByAssetIDs
- Restore assetsassetsUpdateResourceByAssetId
- Updates an existing asset's metadata, tags, and other attributes using its asset IDassetsUpdateResourceByPublicId
- Update asset by public IDexplodeExplodeResource
- Create derived images from multi-page filefoldersCreateFolder
- Creates a new empty folder in your Cloudinary media libraryfoldersDestroyFolder
- Deletes an existing folder from your media libraryfoldersListRootFolders
- Get root foldersfoldersSearchFolders
- Searches for folders whose attributes match a given expressionfoldersSearchFoldersPost
- Searches for folders in your product environmentfoldersShowFolder
- List sub-foldersfoldersUpdateFolder
- Renames or moves an entire folder (along with all assets it contains) to asearchSearchAssets
- Provides a powerful query interface to filter and retrieve assets and their detailssearchVisualSearchAssets
- Finds images in your asset library based on visual similarity or contentuploadDestroyAsset
- Destroys an asset/resourceuploadText
- Create image from textuploadUpload
- Uploads media assets (images, videos, raw files) to your Cloudinary product environmentuploadUploadChunk
- Upload a single chunk of a large fileusageGetUsage
- Retrieves comprehensive usage metrics and account statisticsvideoAnalyticsGetVideoViews
- Get video views
Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.
To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:
import { CloudinaryAssets } from "@cloudinary/assets";
const cloudinaryAssets = new CloudinaryAssets({
cloudName: "<value>",
security: {
apiKey: "CLOUDINARY_API_KEY",
apiSecret: "CLOUDINARY_API_SECRET",
},
});
async function run() {
const result = await cloudinaryAssets.upload.upload("auto", {
headers: "X-Robots-Tag: noindex",
moderation: "google_video_moderation",
rawConvert: "google_speech:vtt:en-US",
backgroundRemoval: "pixelz",
format: "jpg",
allowedFormats: "mp4,ogv,jpg,png,pdf",
autoTagging: 0.5,
detection: "coco_v2",
file: "", // Populate with string from file, for example example.file,
}, {
retries: {
strategy: "backoff",
backoff: {
initialInterval: 1,
maxInterval: 50,
exponent: 1.1,
maxElapsedTime: 100,
},
retryConnectionErrors: false,
},
});
console.log(result);
}
run();
If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:
import { CloudinaryAssets } from "@cloudinary/assets";
const cloudinaryAssets = new CloudinaryAssets({
retryConfig: {
strategy: "backoff",
backoff: {
initialInterval: 1,
maxInterval: 50,
exponent: 1.1,
maxElapsedTime: 100,
},
retryConnectionErrors: false,
},
cloudName: "<value>",
security: {
apiKey: "CLOUDINARY_API_KEY",
apiSecret: "CLOUDINARY_API_SECRET",
},
});
async function run() {
const result = await cloudinaryAssets.upload.upload("auto", {
headers: "X-Robots-Tag: noindex",
moderation: "google_video_moderation",
rawConvert: "google_speech:vtt:en-US",
backgroundRemoval: "pixelz",
format: "jpg",
allowedFormats: "mp4,ogv,jpg,png,pdf",
autoTagging: 0.5,
detection: "coco_v2",
file: "", // Populate with string from file, for example example.file,
});
console.log(result);
}
run();
CloudinaryAssetsError
is the base class for all HTTP error responses. It has the following properties:
Property | Type | Description |
---|---|---|
error.message |
string |
Error message |
error.statusCode |
number |
HTTP response status code eg 404 |
error.headers |
Headers |
HTTP response headers |
error.body |
string |
HTTP body. Can be empty string if no body is returned. |
error.rawResponse |
Response |
Raw HTTP response |
error.data$ |
Optional. Some errors may contain structured data. See Error Classes. |
import { CloudinaryAssets } from "@cloudinary/assets";
import * as errors from "@cloudinary/assets/models/errors";
const cloudinaryAssets = new CloudinaryAssets({
cloudName: "<value>",
security: {
apiKey: "CLOUDINARY_API_KEY",
apiSecret: "CLOUDINARY_API_SECRET",
},
});
async function run() {
try {
const result = await cloudinaryAssets.upload.upload("auto", {
headers: "X-Robots-Tag: noindex",
moderation: "google_video_moderation",
rawConvert: "google_speech:vtt:en-US",
backgroundRemoval: "pixelz",
format: "jpg",
allowedFormats: "mp4,ogv,jpg,png,pdf",
autoTagging: 0.5,
detection: "coco_v2",
file: "", // Populate with string from file, for example example.file,
});
console.log(result);
} catch (error) {
// The base class for HTTP error responses
if (error instanceof errors.CloudinaryAssetsError) {
console.log(error.message);
console.log(error.statusCode);
console.log(error.body);
console.log(error.headers);
// Depending on the method different errors may be thrown
if (error instanceof errors.ApiError) {
console.log(error.data$.error); // components.ApiErrorError
}
}
}
}
run();
Primary errors:
CloudinaryAssetsError
: The base class for HTTP error responses.ApiError
: *
Less common errors (10)
Network errors:
ConnectionError
: HTTP client was unable to make a request to a server.RequestTimeoutError
: HTTP request timed out due to an AbortSignal signal.RequestAbortedError
: HTTP request was aborted by the client.InvalidRequestError
: Any input used to create a request is invalid.UnexpectedClientError
: Unrecognised or unexpected error.
Inherit from CloudinaryAssetsError
:
BadRequestError
: Bad request. Status code400
. Applicable to 1 of 46 methods.*DownloadBackupAssetUnauthorizedError
: Authentication failed. Status code401
. Applicable to 1 of 46 methods.*ListResourceTypesUnauthorizedError
: Authentication failed. Status code401
. Applicable to 1 of 46 methods.*NotFoundError
: Version not found. Status code404
. Applicable to 1 of 46 methods.*ResponseValidationError
: Type mismatch between the data returned from the server and the structure expected by the SDK. Seeerror.rawValue
for the raw value anderror.pretty()
for a nicely formatted multi-line string.
* Check the method documentation to see if the error is applicable.
You can override the default server globally by passing a server index to the serverIdx: number
optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:
# | Server | Variables | Description |
---|---|---|---|
0 | https://{region}.cloudinary.com |
region |
Regional API endpoints for optimal performance. |
1 | https://{host} |
host |
Custom domains for enterprise deployments. |
If the selected server has variables, you may override its default values through the additional parameters made available in the SDK constructor:
Variable | Parameter | Supported Values | Default | Description |
---|---|---|---|---|
region |
region: models.ServerRegion |
- "api" - "api-eu" - "api-ap" |
"api" |
Regional endpoint selection |
host |
host: string |
string | "api.cloudinary.com" |
API host domain. |
import { CloudinaryAssets } from "@cloudinary/assets";
const cloudinaryAssets = new CloudinaryAssets({
serverIdx: 1,
host: "nutritious-fisherman.net",
cloudName: "<value>",
security: {
apiKey: "CLOUDINARY_API_KEY",
apiSecret: "CLOUDINARY_API_SECRET",
},
});
async function run() {
const result = await cloudinaryAssets.upload.upload("auto", {
headers: "X-Robots-Tag: noindex",
moderation: "google_video_moderation",
rawConvert: "google_speech:vtt:en-US",
backgroundRemoval: "pixelz",
format: "jpg",
allowedFormats: "mp4,ogv,jpg,png,pdf",
autoTagging: 0.5,
detection: "coco_v2",
file: "", // Populate with string from file, for example example.file,
});
console.log(result);
}
run();
The default server can also be overridden globally by passing a URL to the serverURL: string
optional parameter when initializing the SDK client instance. For example:
import { CloudinaryAssets } from "@cloudinary/assets";
const cloudinaryAssets = new CloudinaryAssets({
serverURL: "https://api.cloudinary.com",
cloudName: "<value>",
security: {
apiKey: "CLOUDINARY_API_KEY",
apiSecret: "CLOUDINARY_API_SECRET",
},
});
async function run() {
const result = await cloudinaryAssets.upload.upload("auto", {
headers: "X-Robots-Tag: noindex",
moderation: "google_video_moderation",
rawConvert: "google_speech:vtt:en-US",
backgroundRemoval: "pixelz",
format: "jpg",
allowedFormats: "mp4,ogv,jpg,png,pdf",
autoTagging: 0.5,
detection: "coco_v2",
file: "", // Populate with string from file, for example example.file,
});
console.log(result);
}
run();
The TypeScript SDK makes API calls using an HTTPClient
that wraps the native
Fetch API. This
client is a thin wrapper around fetch
and provides the ability to attach hooks
around the request lifecycle that can be used to modify the request or handle
errors and response.
The HTTPClient
constructor takes an optional fetcher
argument that can be
used to integrate a third-party HTTP client or when writing tests to mock out
the HTTP client and feed in fixtures.
The following example shows how to use the "beforeRequest"
hook to to add a
custom header and a timeout to requests and how to use the "requestError"
hook
to log errors:
import { CloudinaryAssets } from "@cloudinary/assets";
import { HTTPClient } from "@cloudinary/assets/lib/http";
const httpClient = new HTTPClient({
// fetcher takes a function that has the same signature as native `fetch`.
fetcher: (request) => {
return fetch(request);
}
});
httpClient.addHook("beforeRequest", (request) => {
const nextRequest = new Request(request, {
signal: request.signal || AbortSignal.timeout(5000)
});
nextRequest.headers.set("x-custom-header", "custom value");
return nextRequest;
});
httpClient.addHook("requestError", (error, request) => {
console.group("Request Error");
console.log("Reason:", `${error}`);
console.log("Endpoint:", `${request.method} ${request.url}`);
console.groupEnd();
});
const sdk = new CloudinaryAssets({ httpClient });
You can setup your SDK to emit debug logs for SDK requests and responses.
You can pass a logger that matches console
's interface as an SDK option.
Warning
Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.
import { CloudinaryAssets } from "@cloudinary/assets";
const sdk = new CloudinaryAssets({ debugLogger: console });
You can also enable a default debug logger by setting an environment variable CLOUDINARY_DEBUG
to true.