Assets

(assets)

Overview

Enables you to manage all the resources (assets) stored in your product environment.

Available Operations

renameAsset - Updates an existing asset's identifier (public ID) 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 your product environment.
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 by asset ID
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

renameAsset

Updates an existing asset's identifier (public ID) and optionally other metadata in your Cloudinary account

Example Usage

import { CloudinaryAssetMgmt } from "@cloudinary/asset-management";

const cloudinaryAssetMgmt = new CloudinaryAssetMgmt({
  cloudName: "<value>",
  security: {
    cloudinaryAuth: {
      apiKey: "CLOUDINARY_API_KEY",
      apiSecret: "CLOUDINARY_API_SECRET",
    },
  },
});

async function run() {
  const result = await cloudinaryAssetMgmt.assets.renameAsset("video", {
    fromPublicId: "<id>",
    toPublicId: "<id>",
  });

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { CloudinaryAssetMgmtCore } from "@cloudinary/asset-management/core.js";
import { assetsRenameAsset } from "@cloudinary/asset-management/funcs/assetsRenameAsset.js";

// Use `CloudinaryAssetMgmtCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const cloudinaryAssetMgmt = new CloudinaryAssetMgmtCore({
  cloudName: "<value>",
  security: {
    cloudinaryAuth: {
      apiKey: "CLOUDINARY_API_KEY",
      apiSecret: "CLOUDINARY_API_SECRET",
    },
  },
});

async function run() {
  const res = await assetsRenameAsset(cloudinaryAssetMgmt, "video", {
    fromPublicId: "<id>",
    toPublicId: "<id>",
  });
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("assetsRenameAsset failed:", res.error);
  }
}

run();

Parameters

Parameter	Type	Required	Description
`resourceType`	components.ResourceType	✔️	The type of resource.
`requestBody`	operations.RenameAssetRequestBody	✔️	N/A
`options`	RequestOptions	➖	Used to set various options for making HTTP requests.
`options.fetchOptions`	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed.
`options.retries`	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<components.UploadResponse>

Errors

Error Type	Status Code	Content Type
errors.ApiError	400, 401, 404	application/json
errors.SDKError	4XX, 5XX	/

downloadAsset

Generates a download link for a specific asset (image)

Example Usage

import { CloudinaryAssetMgmt } from "@cloudinary/asset-management";

const cloudinaryAssetMgmt = new CloudinaryAssetMgmt({
  cloudName: "<value>",
  security: {
    cloudinaryAuth: {
      apiKey: "CLOUDINARY_API_KEY",
      apiSecret: "CLOUDINARY_API_SECRET",
    },
  },
});

async function run() {
  const result = await cloudinaryAssetMgmt.assets.downloadAsset("image", "<id>", "upload", false, "<value>", "<value>", 444233);

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { CloudinaryAssetMgmtCore } from "@cloudinary/asset-management/core.js";
import { assetsDownloadAsset } from "@cloudinary/asset-management/funcs/assetsDownloadAsset.js";

// Use `CloudinaryAssetMgmtCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const cloudinaryAssetMgmt = new CloudinaryAssetMgmtCore({
  cloudName: "<value>",
  security: {
    cloudinaryAuth: {
      apiKey: "CLOUDINARY_API_KEY",
      apiSecret: "CLOUDINARY_API_SECRET",
    },
  },
});

async function run() {
  const res = await assetsDownloadAsset(cloudinaryAssetMgmt, "image", "<id>", "upload", false, "<value>", "<value>", 444233);
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("assetsDownloadAsset failed:", res.error);
  }
}

run();

Parameters

Parameter	Type	Required	Description
`resourceType`	components.ResourceType	✔️	The type of resource.
`publicId`	string	✔️	The public ID of the asset.
`format`	string	➖	The format to convert the asset to before downloading.
`type`	components.StorageType	➖	The storage type of the asset. Default is "upload".
`expiresAt`	number	➖	Unix timestamp indicating when the download URL should expire.
`attachment`	boolean	➖	Whether to force download as an attachment.
`targetFilename`	string	➖	The desired filename for the downloaded file.
`transformation`	string	➖	A transformation to apply to the asset before downloading.
`apiKey`	string	➖	The API key to use for the request. This is automatically computed by the Cloudinary's SDKs.
`signature`	string	➖	(Required for signed REST API calls) Used to authenticate the request and based on the parameters you use in the request. When using the Cloudinary SDKs for signed requests, the signature is automatically generated and added to the request. If you manually generate your own signed POST request, you need to manually generate the signature parameter and add it to the request together with the api_key and timestamp parameters.
`timestamp`	number	➖	The timestamp to use for the request in unix time. This is automatically computed by the Cloudinary's SDKs.
`options`	RequestOptions	➖	Used to set various options for making HTTP requests.
`options.fetchOptions`	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed.
`options.retries`	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<operations.DownloadAssetResponse>

Errors

Error Type	Status Code	Content Type
errors.ApiError	400, 401, 403, 404	application/json
errors.SDKError	4XX, 5XX	/

explicitAsset

Applies actions such as transformations, tags, or metadata updates to an existing asset without re-uploading it. This is useful for applying new transformations, adding tags, or updating metadata on assets that are already in your cloud.

Note: Always prefer delivery URL transformations over this method, unless eager transformations are specifically required.

Example Usage

import { CloudinaryAssetMgmt } from "@cloudinary/asset-management";

const cloudinaryAssetMgmt = new CloudinaryAssetMgmt({
  cloudName: "<value>",
  security: {
    cloudinaryAuth: {
      apiKey: "CLOUDINARY_API_KEY",
      apiSecret: "CLOUDINARY_API_SECRET",
    },
  },
});

async function run() {
  const result = await cloudinaryAssetMgmt.assets.explicitAsset("image", {
    autoTranscription: true,
    headers: "X-Robots-Tag: noindex",
    moderation: "aws_rek_video",
    publicId: "<id>",
  });

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { CloudinaryAssetMgmtCore } from "@cloudinary/asset-management/core.js";
import { assetsExplicitAsset } from "@cloudinary/asset-management/funcs/assetsExplicitAsset.js";

// Use `CloudinaryAssetMgmtCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const cloudinaryAssetMgmt = new CloudinaryAssetMgmtCore({
  cloudName: "<value>",
  security: {
    cloudinaryAuth: {
      apiKey: "CLOUDINARY_API_KEY",
      apiSecret: "CLOUDINARY_API_SECRET",
    },
  },
});

async function run() {
  const res = await assetsExplicitAsset(cloudinaryAssetMgmt, "image", {
    autoTranscription: true,
    headers: "X-Robots-Tag: noindex",
    moderation: "aws_rek_video",
    publicId: "<id>",
  });
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("assetsExplicitAsset failed:", res.error);
  }
}

run();

Parameters

Parameter	Type	Required	Description
`resourceType`	components.ResourceType	✔️	The type of resource.
`requestBody`	operations.ExplicitAssetRequestBody	✔️	N/A
`options`	RequestOptions	➖	Used to set various options for making HTTP requests.
`options.fetchOptions`	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed.
`options.retries`	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<components.UploadResponse>

Errors

Error Type	Status Code	Content Type
errors.ApiError	400, 401, 403, 404	application/json
errors.SDKError	4XX, 5XX	/

generateArchive

Creates a downloadable ZIP or other archive format containing the specified resources.

Example Usage

import { CloudinaryAssetMgmt } from "@cloudinary/asset-management";

const cloudinaryAssetMgmt = new CloudinaryAssetMgmt({
  cloudName: "<value>",
  security: {
    cloudinaryAuth: {
      apiKey: "CLOUDINARY_API_KEY",
      apiSecret: "CLOUDINARY_API_SECRET",
    },
  },
});

async function run() {
  const result = await cloudinaryAssetMgmt.assets.generateArchive("image", {
    targetTags: [
      "animal",
      "dog",
    ],
  });

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { CloudinaryAssetMgmtCore } from "@cloudinary/asset-management/core.js";
import { assetsGenerateArchive } from "@cloudinary/asset-management/funcs/assetsGenerateArchive.js";

// Use `CloudinaryAssetMgmtCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const cloudinaryAssetMgmt = new CloudinaryAssetMgmtCore({
  cloudName: "<value>",
  security: {
    cloudinaryAuth: {
      apiKey: "CLOUDINARY_API_KEY",
      apiSecret: "CLOUDINARY_API_SECRET",
    },
  },
});

async function run() {
  const res = await assetsGenerateArchive(cloudinaryAssetMgmt, "image", {
    targetTags: [
      "animal",
      "dog",
    ],
  });
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("assetsGenerateArchive failed:", res.error);
  }
}

run();

Parameters

Parameter	Type	Required	Description
`resourceType`	components.ArchiveResourceType	✔️	The type of resources to include in the archive. "image" for images, "video" for videos, "raw" for non-media files, or "all" for mixed types.
`requestBody`	operations.GenerateArchiveRequestBody	✔️	N/A
`options`	RequestOptions	➖	Used to set various options for making HTTP requests.
`options.fetchOptions`	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed.
`options.retries`	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<operations.GenerateArchiveResponse>

Errors

Error Type	Status Code	Content Type
errors.ApiError	400, 401	application/json
errors.SDKError	4XX, 5XX	/

downloadBackupAsset

Download a backup copy of an asset

Example Usage

import { CloudinaryAssetMgmt } from "@cloudinary/asset-management";

const cloudinaryAssetMgmt = new CloudinaryAssetMgmt({
  cloudName: "<value>",
  security: {
    cloudinaryAuth: {
      apiKey: "CLOUDINARY_API_KEY",
      apiSecret: "CLOUDINARY_API_SECRET",
    },
  },
});

async function run() {
  const result = await cloudinaryAssetMgmt.assets.downloadBackupAsset("f4e6579cf84dd9cf5683b21f5b30c7d9", "a3978316b0045e5eaf198f4d6885ca35", "<value>", "<value>", 723931);

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { CloudinaryAssetMgmtCore } from "@cloudinary/asset-management/core.js";
import { assetsDownloadBackupAsset } from "@cloudinary/asset-management/funcs/assetsDownloadBackupAsset.js";

// Use `CloudinaryAssetMgmtCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const cloudinaryAssetMgmt = new CloudinaryAssetMgmtCore({
  cloudName: "<value>",
  security: {
    cloudinaryAuth: {
      apiKey: "CLOUDINARY_API_KEY",
      apiSecret: "CLOUDINARY_API_SECRET",
    },
  },
});

async function run() {
  const res = await assetsDownloadBackupAsset(cloudinaryAssetMgmt, "f4e6579cf84dd9cf5683b21f5b30c7d9", "a3978316b0045e5eaf198f4d6885ca35", "<value>", "<value>", 723931);
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("assetsDownloadBackupAsset failed:", res.error);
  }
}

run();

Parameters

Parameter	Type	Required	Description	Example
`assetId`	string	✔️	The asset ID of the resource. Must be a 32-character hexadecimal string.	[object Object]
`versionId`	string	✔️	The version ID of the backup to download. Must be a 32-character hexadecimal string.	[object Object]
`apiKey`	string	➖	The API key to use for the request. This is automatically computed by the Cloudinary's SDKs.
`signature`	string	➖	(Required for signed REST API calls) Used to authenticate the request and based on the parameters you use in the request. When using the Cloudinary SDKs for signed requests, the signature is automatically generated and added to the request. If you manually generate your own signed POST request, you need to manually generate the signature parameter and add it to the request together with the api_key and timestamp parameters.
`timestamp`	number	➖	The timestamp to use for the request in unix time. This is automatically computed by the Cloudinary's SDKs.
`options`	RequestOptions	➖	Used to set various options for making HTTP requests.
`options.fetchOptions`	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed.
`options.retries`	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<operations.DownloadBackupAssetResponse>

Errors

Error Type	Status Code	Content Type
errors.BadRequestError	400	application/json
errors.DownloadBackupAssetUnauthorizedError	401	application/json
errors.NotFoundError	404	application/json
errors.SDKError	4XX, 5XX	/

destroyByAssetId

Deletes an asset using its asset ID. This endpoint replaces the legacy /resources/by_asset_id endpoint. Returns the deletion status and asset folder information when folder decoupling is enabled.

Example Usage

import { CloudinaryAssetMgmt } from "@cloudinary/asset-management";

const cloudinaryAssetMgmt = new CloudinaryAssetMgmt({
  cloudName: "<value>",
  security: {
    cloudinaryAuth: {
      apiKey: "CLOUDINARY_API_KEY",
      apiSecret: "CLOUDINARY_API_SECRET",
    },
  },
});

async function run() {
  const result = await cloudinaryAssetMgmt.assets.destroyByAssetId({
    assetId: "<id>",
  });

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { CloudinaryAssetMgmtCore } from "@cloudinary/asset-management/core.js";
import { assetsDestroyByAssetId } from "@cloudinary/asset-management/funcs/assetsDestroyByAssetId.js";

// Use `CloudinaryAssetMgmtCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const cloudinaryAssetMgmt = new CloudinaryAssetMgmtCore({
  cloudName: "<value>",
  security: {
    cloudinaryAuth: {
      apiKey: "CLOUDINARY_API_KEY",
      apiSecret: "CLOUDINARY_API_SECRET",
    },
  },
});

async function run() {
  const res = await assetsDestroyByAssetId(cloudinaryAssetMgmt, {
    assetId: "<id>",
  });
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("assetsDestroyByAssetId failed:", res.error);
  }
}

run();

Parameters

Parameter	Type	Required	Description
`assetId`	string	✔️	The ID of the asset to delete.
`apiKey`	string	➖	The API key to use for the request. This is automatically computed by the Cloudinary's SDKs.
`timestamp`	number	➖	The timestamp to use for the request in unix time. This is automatically computed by the Cloudinary's SDKs.
`signature`	string	➖	(Required for signed REST API calls) Used to authenticate the request and based on the parameters you use in the request. When using the Cloudinary SDKs for signed requests, the signature is automatically generated and added to the request. If you manually generate your own signed POST request, you need to manually generate the signature parameter and add it to the request together with the api_key and timestamp parameters.
`invalidate`	boolean	➖	Whether to invalidate CDN cache. Default is false.
`notificationUrl`	string	➖	URL to receive completion notification.
`callback`	string	➖	URL for redirect after operation completion.
`options`	RequestOptions	➖	Used to set various options for making HTTP requests.
`options.fetchOptions`	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed.
`options.retries`	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<components.DestroyResponse>

Errors

Error Type	Status Code	Content Type
errors.ApiError	400, 401, 403	application/json
errors.SDKError	4XX, 5XX	/

listResourceTypes

Returns a list of all resource types that correspond to assets currently in your product environment.

Example Usage

import { CloudinaryAssetMgmt } from "@cloudinary/asset-management";

const cloudinaryAssetMgmt = new CloudinaryAssetMgmt({
  cloudName: "<value>",
  security: {
    cloudinaryAuth: {
      apiKey: "CLOUDINARY_API_KEY",
      apiSecret: "CLOUDINARY_API_SECRET",
    },
  },
});

async function run() {
  const result = await cloudinaryAssetMgmt.assets.listResourceTypes({});

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { CloudinaryAssetMgmtCore } from "@cloudinary/asset-management/core.js";
import { assetsListResourceTypes } from "@cloudinary/asset-management/funcs/assetsListResourceTypes.js";

// Use `CloudinaryAssetMgmtCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const cloudinaryAssetMgmt = new CloudinaryAssetMgmtCore({
  cloudName: "<value>",
  security: {
    cloudinaryAuth: {
      apiKey: "CLOUDINARY_API_KEY",
      apiSecret: "CLOUDINARY_API_SECRET",
    },
  },
});

async function run() {
  const res = await assetsListResourceTypes(cloudinaryAssetMgmt, {});
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("assetsListResourceTypes failed:", res.error);
  }
}

run();

Parameters

Parameter	Type	Required	Description
`options`	RequestOptions	➖	Used to set various options for making HTTP requests.
`options.fetchOptions`	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed.
`options.retries`	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<operations.ListResourceTypesResponse>

Errors

Error Type	Status Code	Content Type
errors.ListResourceTypesUnauthorizedError	401	application/json
errors.SDKError	4XX, 5XX	/

listImages

Retrieves a list of image assets. Results can be filtered by various criteria like tags, moderation status, prefix, or specific public IDs.

Example Usage

import { CloudinaryAssetMgmt } from "@cloudinary/asset-management";

const cloudinaryAssetMgmt = new CloudinaryAssetMgmt({
  cloudName: "<value>",
  security: {
    cloudinaryAuth: {
      apiKey: "CLOUDINARY_API_KEY",
      apiSecret: "CLOUDINARY_API_SECRET",
    },
  },
});

async function run() {
  const result = await cloudinaryAssetMgmt.assets.listImages([
    "sample",
    "product_image",
    "banner_2023",
  ]);

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { CloudinaryAssetMgmtCore } from "@cloudinary/asset-management/core.js";
import { assetsListImages } from "@cloudinary/asset-management/funcs/assetsListImages.js";

// Use `CloudinaryAssetMgmtCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const cloudinaryAssetMgmt = new CloudinaryAssetMgmtCore({
  cloudName: "<value>",
  security: {
    cloudinaryAuth: {
      apiKey: "CLOUDINARY_API_KEY",
      apiSecret: "CLOUDINARY_API_SECRET",
    },
  },
});

async function run() {
  const res = await assetsListImages(cloudinaryAssetMgmt, [
    "sample",
    "product_image",
    "banner_2023",
  ]);
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("assetsListImages failed:", res.error);
  }
}

run();

Parameters

Parameter	Type	Required	Description	Example
`type`	components.ListStorageType	➖	The storage type of the assets. Necessary for prefix filtering.
`prefix`	string	➖	Find resources with a public ID prefix. Requires the `type` parameter.
`publicIds`	string[]	➖	An array of public IDs to return.	[object Object]
`tags`	boolean	➖	Whether to include the list of tag names assigned to each asset. Default: false
`nextCursor`	string	➖	Cursor for pagination.
`maxResults`	number	➖	Maximum number of results to return (1-500).
`direction`	components.Direction	➖	Sort direction.
`startAt`	Date	➖	Retrieve resources uploaded after this timestamp.
`fields`	components.FieldsSpec[]	➖	N/A
`options`	RequestOptions	➖	Used to set various options for making HTTP requests.
`options.fetchOptions`	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed.
`options.retries`	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<components.ListResponse>

Errors

Error Type	Status Code	Content Type
errors.ApiError	400, 401	application/json
errors.SDKError	4XX, 5XX	/

listVideos

Retrieves a list of video assets. Results can be filtered by various criteria like tags, moderation status, prefix, or specific public IDs.

Example Usage

import { CloudinaryAssetMgmt } from "@cloudinary/asset-management";

const cloudinaryAssetMgmt = new CloudinaryAssetMgmt({
  cloudName: "<value>",
  security: {
    cloudinaryAuth: {
      apiKey: "CLOUDINARY_API_KEY",
      apiSecret: "CLOUDINARY_API_SECRET",
    },
  },
});

async function run() {
  const result = await cloudinaryAssetMgmt.assets.listVideos([
    "sample",
    "product_image",
    "banner_2023",
  ]);

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { CloudinaryAssetMgmtCore } from "@cloudinary/asset-management/core.js";
import { assetsListVideos } from "@cloudinary/asset-management/funcs/assetsListVideos.js";

// Use `CloudinaryAssetMgmtCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const cloudinaryAssetMgmt = new CloudinaryAssetMgmtCore({
  cloudName: "<value>",
  security: {
    cloudinaryAuth: {
      apiKey: "CLOUDINARY_API_KEY",
      apiSecret: "CLOUDINARY_API_SECRET",
    },
  },
});

async function run() {
  const res = await assetsListVideos(cloudinaryAssetMgmt, [
    "sample",
    "product_image",
    "banner_2023",
  ]);
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("assetsListVideos failed:", res.error);
  }
}

run();

Parameters

Parameter	Type	Required	Description	Example
`type`	components.ListStorageType	➖	The storage type of the assets. Necessary for prefix filtering.
`prefix`	string	➖	A public_id prefix. When specified, all assets with that prefix are returned. When using this, the `type` parameter must also be specified.
`publicIds`	string[]	➖	An array of public IDs to return.	[object Object]
`tags`	boolean	➖	Whether to include the list of tag names assigned to each asset. Default: false
`nextCursor`	string	➖	Cursor for pagination.
`maxResults`	number	➖	Maximum number of results to return (1-500).
`direction`	components.Direction	➖	Sort direction.
`startAt`	Date	➖	An ISO-8601 formatted timestamp. When specified, assets created since that timestamp are returned. Supported only if neither `prefix` nor `public_ids` were passed.
`fields`	components.FieldsSpec[]	➖	N/A
`options`	RequestOptions	➖	Used to set various options for making HTTP requests.
`options.fetchOptions`	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed.
`options.retries`	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<components.ListResponse>

Errors

Error Type	Status Code	Content Type
errors.ApiError	400, 401	application/json
errors.SDKError	4XX, 5XX	/

listRawFiles

Retrieves a list of raw assets. Results can be filtered by various criteria like tags, moderation status, prefix, or specific public IDs.

Example Usage

import { CloudinaryAssetMgmt } from "@cloudinary/asset-management";

const cloudinaryAssetMgmt = new CloudinaryAssetMgmt({
  cloudName: "<value>",
  security: {
    cloudinaryAuth: {
      apiKey: "CLOUDINARY_API_KEY",
      apiSecret: "CLOUDINARY_API_SECRET",
    },
  },
});

async function run() {
  const result = await cloudinaryAssetMgmt.assets.listRawFiles([
    "sample",
    "product_image",
    "banner_2023",
  ]);

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { CloudinaryAssetMgmtCore } from "@cloudinary/asset-management/core.js";
import { assetsListRawFiles } from "@cloudinary/asset-management/funcs/assetsListRawFiles.js";

// Use `CloudinaryAssetMgmtCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const cloudinaryAssetMgmt = new CloudinaryAssetMgmtCore({
  cloudName: "<value>",
  security: {
    cloudinaryAuth: {
      apiKey: "CLOUDINARY_API_KEY",
      apiSecret: "CLOUDINARY_API_SECRET",
    },
  },
});

async function run() {
  const res = await assetsListRawFiles(cloudinaryAssetMgmt, [
    "sample",
    "product_image",
    "banner_2023",
  ]);
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("assetsListRawFiles failed:", res.error);
  }
}

run();

Parameters

Parameter	Type	Required	Description	Example
`type`	components.ListStorageType	➖	The storage type of the assets. Necessary for prefix filtering.
`prefix`	string	➖	A public_id prefix. When specified, all assets with that prefix are returned. When using this, the `type` parameter must also be specified.
`publicIds`	string[]	➖	An array of public IDs to return.	[object Object]
`tags`	boolean	➖	Whether to include the list of tag names assigned to each asset. Default: false
`nextCursor`	string	➖	Cursor for pagination.
`maxResults`	number	➖	Maximum number of results to return (1-500).
`direction`	components.Direction	➖	Sort direction.
`startAt`	Date	➖	An ISO-8601 formatted timestamp. When specified, assets created since that timestamp are returned. Supported only if neither `prefix` nor `public_ids` were passed.
`fields`	components.FieldsSpec[]	➖	N/A
`options`	RequestOptions	➖	Used to set various options for making HTTP requests.
`options.fetchOptions`	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed.
`options.retries`	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<components.ListResponse>

Errors

Error Type	Status Code	Content Type
errors.ApiError	400, 401	application/json
errors.SDKError	4XX, 5XX	/

listResourcesByAssetFolder

Retrieves a list of resources within a specific asset folder. Requires folder decoupling to be enabled.

Example Usage

import { CloudinaryAssetMgmt } from "@cloudinary/asset-management";

const cloudinaryAssetMgmt = new CloudinaryAssetMgmt({
  cloudName: "<value>",
  security: {
    cloudinaryAuth: {
      apiKey: "CLOUDINARY_API_KEY",
      apiSecret: "CLOUDINARY_API_SECRET",
    },
  },
});

async function run() {
  const result = await cloudinaryAssetMgmt.assets.listResourcesByAssetFolder("<value>");

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { CloudinaryAssetMgmtCore } from "@cloudinary/asset-management/core.js";
import { assetsListResourcesByAssetFolder } from "@cloudinary/asset-management/funcs/assetsListResourcesByAssetFolder.js";

// Use `CloudinaryAssetMgmtCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const cloudinaryAssetMgmt = new CloudinaryAssetMgmtCore({
  cloudName: "<value>",
  security: {
    cloudinaryAuth: {
      apiKey: "CLOUDINARY_API_KEY",
      apiSecret: "CLOUDINARY_API_SECRET",
    },
  },
});

async function run() {
  const res = await assetsListResourcesByAssetFolder(cloudinaryAssetMgmt, "<value>");
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("assetsListResourcesByAssetFolder failed:", res.error);
  }
}

run();

Parameters

Parameter	Type	Required	Description
`assetFolder`	string	✔️	The full path of the asset folder.
`resourceType`	components.ResourceType	➖	Filter by resource type within the folder.
`nextCursor`	string	➖	Cursor for pagination.
`maxResults`	number	➖	Maximum number of results to return (1-500).
`direction`	components.Direction	➖	Sort direction.
`fields`	components.FieldsSpec[]	➖	N/A
`options`	RequestOptions	➖	Used to set various options for making HTTP requests.
`options.fetchOptions`	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed.
`options.retries`	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<components.ListResponse>

Errors

Error Type	Status Code	Content Type
errors.ApiError	400, 401, 404	application/json
errors.SDKError	4XX, 5XX	/

listResourcesByAssetIDs

Retrieves details for specific resources using their asset IDs (or external IDs).

Example Usage

import { CloudinaryAssetMgmt } from "@cloudinary/asset-management";

const cloudinaryAssetMgmt = new CloudinaryAssetMgmt({
  cloudName: "<value>",
  security: {
    cloudinaryAuth: {
      apiKey: "CLOUDINARY_API_KEY",
      apiSecret: "CLOUDINARY_API_SECRET",
    },
  },
});

async function run() {
  const result = await cloudinaryAssetMgmt.assets.listResourcesByAssetIDs([]);

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { CloudinaryAssetMgmtCore } from "@cloudinary/asset-management/core.js";
import { assetsListResourcesByAssetIDs } from "@cloudinary/asset-management/funcs/assetsListResourcesByAssetIDs.js";

// Use `CloudinaryAssetMgmtCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const cloudinaryAssetMgmt = new CloudinaryAssetMgmtCore({
  cloudName: "<value>",
  security: {
    cloudinaryAuth: {
      apiKey: "CLOUDINARY_API_KEY",
      apiSecret: "CLOUDINARY_API_SECRET",
    },
  },
});

async function run() {
  const res = await assetsListResourcesByAssetIDs(cloudinaryAssetMgmt, []);
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("assetsListResourcesByAssetIDs failed:", res.error);
  }
}

run();

Parameters

Parameter	Type	Required	Description
`assetIds`	string[]	✔️	List of asset IDs to retrieve (max 100).
`resourceType`	components.ResourceType	➖	Resource type (optional, can sometimes disambiguate).
`fields`	components.FieldsSpec[]	➖	N/A
`options`	RequestOptions	➖	Used to set various options for making HTTP requests.
`options.fetchOptions`	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed.
`options.retries`	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<components.ListResponse>

Errors

Error Type	Status Code	Content Type
errors.ApiError	400, 401, 404	application/json
errors.SDKError	4XX, 5XX	/

listResourcesByContext

Retrieves resources matching specific context key/value pairs.

Example Usage

import { CloudinaryAssetMgmt } from "@cloudinary/asset-management";

const cloudinaryAssetMgmt = new CloudinaryAssetMgmt({
  cloudName: "<value>",
  security: {
    cloudinaryAuth: {
      apiKey: "CLOUDINARY_API_KEY",
      apiSecret: "CLOUDINARY_API_SECRET",
    },
  },
});

async function run() {
  const result = await cloudinaryAssetMgmt.assets.listResourcesByContext("raw", "<key>");

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { CloudinaryAssetMgmtCore } from "@cloudinary/asset-management/core.js";
import { assetsListResourcesByContext } from "@cloudinary/asset-management/funcs/assetsListResourcesByContext.js";

// Use `CloudinaryAssetMgmtCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const cloudinaryAssetMgmt = new CloudinaryAssetMgmtCore({
  cloudName: "<value>",
  security: {
    cloudinaryAuth: {
      apiKey: "CLOUDINARY_API_KEY",
      apiSecret: "CLOUDINARY_API_SECRET",
    },
  },
});

async function run() {
  const res = await assetsListResourcesByContext(cloudinaryAssetMgmt, "raw", "<key>");
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("assetsListResourcesByContext failed:", res.error);
  }
}

run();

Parameters

Parameter	Type	Required	Description
`resourceType`	components.ResourceType	✔️	The type of resource.
`key`	string	✔️	Context key to filter by.
`value`	string	➖	Context value to filter by.
`nextCursor`	string	➖	Cursor for pagination.
`maxResults`	number	➖	Maximum number of results to return (1-500).
`direction`	components.Direction	➖	Sort direction.
`fields`	components.FieldsSpec[]	➖	N/A
`options`	RequestOptions	➖	Used to set various options for making HTTP requests.
`options.fetchOptions`	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed.
`options.retries`	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<components.ListResponse>

Errors

Error Type	Status Code	Content Type
errors.ApiError	400, 401	application/json
errors.SDKError	4XX, 5XX	/

listResourcesByModerationKindAndStatus

Retrieves resources matching specific moderation kind and status.

Example Usage

import { CloudinaryAssetMgmt } from "@cloudinary/asset-management";

const cloudinaryAssetMgmt = new CloudinaryAssetMgmt({
  cloudName: "<value>",
  security: {
    cloudinaryAuth: {
      apiKey: "CLOUDINARY_API_KEY",
      apiSecret: "CLOUDINARY_API_SECRET",
    },
  },
});

async function run() {
  const result = await cloudinaryAssetMgmt.assets.listResourcesByModerationKindAndStatus("raw", "aws_rek", "aborted");

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { CloudinaryAssetMgmtCore } from "@cloudinary/asset-management/core.js";
import { assetsListResourcesByModerationKindAndStatus } from "@cloudinary/asset-management/funcs/assetsListResourcesByModerationKindAndStatus.js";

// Use `CloudinaryAssetMgmtCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const cloudinaryAssetMgmt = new CloudinaryAssetMgmtCore({
  cloudName: "<value>",
  security: {
    cloudinaryAuth: {
      apiKey: "CLOUDINARY_API_KEY",
      apiSecret: "CLOUDINARY_API_SECRET",
    },
  },
});

async function run() {
  const res = await assetsListResourcesByModerationKindAndStatus(cloudinaryAssetMgmt, "raw", "aws_rek", "aborted");
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("assetsListResourcesByModerationKindAndStatus failed:", res.error);
  }
}

run();

Parameters

Parameter	Type	Required	Description
`resourceType`	components.ResourceType	✔️	The type of resource.
`moderationKind`	operations.ModerationKind	✔️	N/A
`moderationStatus`	operations.ModerationStatus	✔️	N/A
`fields`	components.FieldsSpec[]	➖	N/A
`nextCursor`	string	➖	Cursor for pagination.
`maxResults`	number	➖	Maximum number of results to return (1-500).
`direction`	components.Direction	➖	Sort direction.
`options`	RequestOptions	➖	Used to set various options for making HTTP requests.
`options.fetchOptions`	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed.
`options.retries`	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<components.ListResponse>

Errors

Error Type	Status Code	Content Type
errors.ApiError	400, 401	application/json
errors.SDKError	4XX, 5XX	/

restoreResourcesByAssetIDs

Restores one or more resources from backup using their asset IDs. Can optionally specify versions to restore.

Example Usage

import { CloudinaryAssetMgmt } from "@cloudinary/asset-management";

const cloudinaryAssetMgmt = new CloudinaryAssetMgmt({
  cloudName: "<value>",
  security: {
    cloudinaryAuth: {
      apiKey: "CLOUDINARY_API_KEY",
      apiSecret: "CLOUDINARY_API_SECRET",
    },
  },
});

async function run() {
  const result = await cloudinaryAssetMgmt.assets.restoreResourcesByAssetIDs({
    assetIds: [
      "2262b0b5eb88f1fd7724e29b0e57d730",
      "d23c0526e6feca2c343e40c2fce5231a",
    ],
  });

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { CloudinaryAssetMgmtCore } from "@cloudinary/asset-management/core.js";
import { assetsRestoreResourcesByAssetIDs } from "@cloudinary/asset-management/funcs/assetsRestoreResourcesByAssetIDs.js";

// Use `CloudinaryAssetMgmtCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const cloudinaryAssetMgmt = new CloudinaryAssetMgmtCore({
  cloudName: "<value>",
  security: {
    cloudinaryAuth: {
      apiKey: "CLOUDINARY_API_KEY",
      apiSecret: "CLOUDINARY_API_SECRET",
    },
  },
});

async function run() {
  const res = await assetsRestoreResourcesByAssetIDs(cloudinaryAssetMgmt, {
    assetIds: [
      "2262b0b5eb88f1fd7724e29b0e57d730",
      "d23c0526e6feca2c343e40c2fce5231a",
    ],
  });
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("assetsRestoreResourcesByAssetIDs failed:", res.error);
  }
}

run();

Parameters

Parameter	Type	Required	Description	Example
`assetIds`	string[]	✔️	The unique and immutable asset IDs of backed up assets to restore.	[object Object]
`versions`	string[]	➖	If you specify versions, the number of versions in the array must exactly match the number of asset_ids.	[object Object]
`notificationUrl`	string	➖	The URL that will receive notification when restore is complete.	[object Object]
`options`	RequestOptions	➖	Used to set various options for making HTTP requests.
`options.fetchOptions`	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed.
`options.retries`	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<{ [k: string]: components.RestoreResponseUnion }>

Errors

Error Type	Status Code	Content Type
errors.ApiError	400, 401, 403	application/json
errors.SDKError	4XX, 5XX	/

deleteResourcesByPublicId

Deletes assets uploaded to your product environment, identified by their public IDs.

Example Usage

import { CloudinaryAssetMgmt } from "@cloudinary/asset-management";

const cloudinaryAssetMgmt = new CloudinaryAssetMgmt({
  cloudName: "<value>",
  security: {
    cloudinaryAuth: {
      apiKey: "CLOUDINARY_API_KEY",
      apiSecret: "CLOUDINARY_API_SECRET",
    },
  },
});

async function run() {
  const result = await cloudinaryAssetMgmt.assets.deleteResourcesByPublicId("raw", "authenticated", {
    all: false,
    resourceType: "image",
    keepOriginal: false,
    invalidate: false,
  });

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { CloudinaryAssetMgmtCore } from "@cloudinary/asset-management/core.js";
import { assetsDeleteResourcesByPublicId } from "@cloudinary/asset-management/funcs/assetsDeleteResourcesByPublicId.js";

// Use `CloudinaryAssetMgmtCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const cloudinaryAssetMgmt = new CloudinaryAssetMgmtCore({
  cloudName: "<value>",
  security: {
    cloudinaryAuth: {
      apiKey: "CLOUDINARY_API_KEY",
      apiSecret: "CLOUDINARY_API_SECRET",
    },
  },
});

async function run() {
  const res = await assetsDeleteResourcesByPublicId(cloudinaryAssetMgmt, "raw", "authenticated", {
    all: false,
    resourceType: "image",
    keepOriginal: false,
    invalidate: false,
  });
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("assetsDeleteResourcesByPublicId failed:", res.error);
  }
}

run();

Parameters

Parameter	Type	Required	Description
`resourceType`	components.ResourceType	✔️	The type of resource.
`type`	components.ExtendedStorageType	✔️	The extended storage type of the resource.
`deleteResourceByPublicIdsRequest`	components.DeleteResourceByPublicIdsRequestUnion	✔️	N/A
`options`	RequestOptions	➖	Used to set various options for making HTTP requests.
`options.fetchOptions`	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed.
`options.retries`	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<operations.DeleteResourcesByPublicIdResponse>

Errors

Error Type	Status Code	Content Type
errors.ApiError	400, 401, 404	application/json
errors.SDKError	4XX, 5XX	/

getResourceByPublicId

Returns the details of a single resource specified by its public ID.

Example Usage

import { CloudinaryAssetMgmt } from "@cloudinary/asset-management";

const cloudinaryAssetMgmt = new CloudinaryAssetMgmt({
  cloudName: "<value>",
  security: {
    cloudinaryAuth: {
      apiKey: "CLOUDINARY_API_KEY",
      apiSecret: "CLOUDINARY_API_SECRET",
    },
  },
});

async function run() {
  const result = await cloudinaryAssetMgmt.assets.getResourceByPublicId("raw", "list", "<id>");

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { CloudinaryAssetMgmtCore } from "@cloudinary/asset-management/core.js";
import { assetsGetResourceByPublicId } from "@cloudinary/asset-management/funcs/assetsGetResourceByPublicId.js";

// Use `CloudinaryAssetMgmtCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const cloudinaryAssetMgmt = new CloudinaryAssetMgmtCore({
  cloudName: "<value>",
  security: {
    cloudinaryAuth: {
      apiKey: "CLOUDINARY_API_KEY",
      apiSecret: "CLOUDINARY_API_SECRET",
    },
  },
});

async function run() {
  const res = await assetsGetResourceByPublicId(cloudinaryAssetMgmt, "raw", "list", "<id>");
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("assetsGetResourceByPublicId failed:", res.error);
  }
}

run();

Parameters

Parameter	Type	Required	Description
`resourceType`	components.ResourceType	✔️	The type of resource.
`type`	components.ExtendedStorageType	✔️	The extended storage type of the resource.
`publicId`	string	✔️	The public ID of the asset.
`colors`	boolean	➖	Whether to include color information (predominant colors and histogram of 32 leading colors). Default: false.
`mediaMetadata`	boolean	➖	Whether to include IPTC, XMP, and detailed Exif metadata in the response. Default: false.
`faces`	boolean	➖	Whether to include a list of coordinates of detected faces. Default: false.
`qualityAnalysis`	boolean	➖	Whether to return quality analysis scores for the image. Default: false.
`accessibilityAnalysis`	boolean	➖	Whether to return accessibility analysis scores for the image. Default: false.
`pages`	boolean	➖	Whether to report the number of pages in multi-page documents (e.g., PDF). Default: false.
`phash`	boolean	➖	Whether to include the perceptual hash (pHash) of the uploaded photo for image similarity detection. Default: false.
`coordinates`	boolean	➖	Whether to include previously specified custom cropping coordinates and faces coordinates. Default: false.
`versions`	boolean	➖	Whether to include details of all the backed up versions of the asset. Default: false.
`maxResults`	number	➖	Maximum number of derived assets to return. Default: 10.
`derivedNextCursor`	string	➖	The cursor for the next page of derived assets when there are more derived images than max_results.
`options`	RequestOptions	➖	Used to set various options for making HTTP requests.
`options.fetchOptions`	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed.
`options.retries`	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<components.Info>

Errors

Error Type	Status Code	Content Type
errors.ApiError	400, 401, 404	application/json
errors.SDKError	4XX, 5XX	/

updateResourceByPublicId

Updates one or more attributes of a specified resource (asset) identified by its public ID. Note that you can also update many attributes of an existing asset using the explicit method, which is not rate limited.

Example Usage

import { CloudinaryAssetMgmt } from "@cloudinary/asset-management";

const cloudinaryAssetMgmt = new CloudinaryAssetMgmt({
  cloudName: "<value>",
  security: {
    cloudinaryAuth: {
      apiKey: "CLOUDINARY_API_KEY",
      apiSecret: "CLOUDINARY_API_SECRET",
    },
  },
});

async function run() {
  const result = await cloudinaryAssetMgmt.assets.updateResourceByPublicId("image", "dailymotion", "<id>", {
    displayName: "My Product Image",
    assetFolder: "products/summer",
    tags: "product,summer,sale",
    context: "alt=My product image|caption=Summer collection",
    metadata: "in_stock_id=50|color_id=[\"green\",\"red\"]",
    faceCoordinates: "10,20,150,130|213,345,82,61",
    customCoordinates: "10,20,150,130|213,345,82,61",
    regions: "{\"name1\":[[1,2],[3,4]],\"name2\":[[5,6],[7,8],[9,10]]}",
    qualityOverride: "80:420",
    detection: "captioning",
    accessControl: [
      {
        accessType: "token",
        key: "prod2024",
      },
      {
        accessType: "anonymous",
        start: new Date("2024-03-15T09:00:00Z"),
        end: new Date("2024-06-30T23:59:59Z"),
      },
    ],
  });

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { CloudinaryAssetMgmtCore } from "@cloudinary/asset-management/core.js";
import { assetsUpdateResourceByPublicId } from "@cloudinary/asset-management/funcs/assetsUpdateResourceByPublicId.js";

// Use `CloudinaryAssetMgmtCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const cloudinaryAssetMgmt = new CloudinaryAssetMgmtCore({
  cloudName: "<value>",
  security: {
    cloudinaryAuth: {
      apiKey: "CLOUDINARY_API_KEY",
      apiSecret: "CLOUDINARY_API_SECRET",
    },
  },
});

async function run() {
  const res = await assetsUpdateResourceByPublicId(cloudinaryAssetMgmt, "image", "dailymotion", "<id>", {
    displayName: "My Product Image",
    assetFolder: "products/summer",
    tags: "product,summer,sale",
    context: "alt=My product image|caption=Summer collection",
    metadata: "in_stock_id=50|color_id=[\"green\",\"red\"]",
    faceCoordinates: "10,20,150,130|213,345,82,61",
    customCoordinates: "10,20,150,130|213,345,82,61",
    regions: "{\"name1\":[[1,2],[3,4]],\"name2\":[[5,6],[7,8],[9,10]]}",
    qualityOverride: "80:420",
    detection: "captioning",
    accessControl: [
      {
        accessType: "token",
        key: "prod2024",
      },
      {
        accessType: "anonymous",
        start: new Date("2024-03-15T09:00:00Z"),
        end: new Date("2024-06-30T23:59:59Z"),
      },
    ],
  });
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("assetsUpdateResourceByPublicId failed:", res.error);
  }
}

run();

Parameters

Parameter	Type	Required	Description
`resourceType`	components.ResourceType	✔️	The type of resource.
`type`	components.ExtendedStorageType	✔️	The extended storage type of the resource.
`publicId`	string	✔️	The public ID of the asset.
`resourceUpdateRequest`	components.ResourceUpdateRequest	✔️	N/A
`options`	RequestOptions	➖	Used to set various options for making HTTP requests.
`options.fetchOptions`	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed.
`options.retries`	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<components.Info>

Errors

Error Type	Status Code	Content Type
errors.ApiError	400, 401, 404	application/json
errors.SDKError	4XX, 5XX	/

getResourceByAssetId

Returns the details of a single resource specified by its asset ID.

Example Usage

import { CloudinaryAssetMgmt } from "@cloudinary/asset-management";

const cloudinaryAssetMgmt = new CloudinaryAssetMgmt({
  cloudName: "<value>",
  security: {
    cloudinaryAuth: {
      apiKey: "CLOUDINARY_API_KEY",
      apiSecret: "CLOUDINARY_API_SECRET",
    },
  },
});

async function run() {
  const result = await cloudinaryAssetMgmt.assets.getResourceByAssetId("e9b44a374f66ad53a64a74c7398f7");

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { CloudinaryAssetMgmtCore } from "@cloudinary/asset-management/core.js";
import { assetsGetResourceByAssetId } from "@cloudinary/asset-management/funcs/assetsGetResourceByAssetId.js";

// Use `CloudinaryAssetMgmtCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const cloudinaryAssetMgmt = new CloudinaryAssetMgmtCore({
  cloudName: "<value>",
  security: {
    cloudinaryAuth: {
      apiKey: "CLOUDINARY_API_KEY",
      apiSecret: "CLOUDINARY_API_SECRET",
    },
  },
});

async function run() {
  const res = await assetsGetResourceByAssetId(cloudinaryAssetMgmt, "e9b44a374f66ad53a64a74c7398f7");
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("assetsGetResourceByAssetId failed:", res.error);
  }
}

run();

Parameters

Parameter	Type	Required	Description	Example
`assetId`	string	✔️	The asset ID of the resource. Must be a 32-character hexadecimal string.	[object Object]
`colors`	boolean	➖	Whether to include color information (predominant colors and histogram of 32 leading colors). Default: false.
`mediaMetadata`	boolean	➖	Whether to include IPTC, XMP, and detailed Exif metadata in the response. Default: false.
`faces`	boolean	➖	Whether to include a list of coordinates of detected faces. Default: false.
`qualityAnalysis`	boolean	➖	Whether to return quality analysis scores for the image. Default: false.
`accessibilityAnalysis`	boolean	➖	Whether to return accessibility analysis scores for the image. Default: false.
`pages`	boolean	➖	Whether to report the number of pages in multi-page documents (e.g., PDF). Default: false.
`phash`	boolean	➖	Whether to include the perceptual hash (pHash) of the uploaded photo for image similarity detection. Default: false.
`coordinates`	boolean	➖	Whether to include previously specified custom cropping coordinates and faces coordinates. Default: false.
`versions`	boolean	➖	Whether to include details of all the backed up versions of the asset. Default: false.
`maxResults`	number	➖	Maximum number of derived assets to return. Default: 10.
`derivedNextCursor`	string	➖	The cursor for the next page of derived assets when there are more derived images than max_results.
`options`	RequestOptions	➖	Used to set various options for making HTTP requests.
`options.fetchOptions`	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed.
`options.retries`	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<components.Info>

Errors

Error Type	Status Code	Content Type
errors.ApiError	400, 401, 404	application/json
errors.SDKError	4XX, 5XX	/

updateResourceByAssetId

Updates one or more attributes of a specified resource (asset) by its asset ID. This enables you to update details of an asset by its unique and immutable identifier, regardless of public ID, display name, asset folder, resource type or deliver type. Note that you can also update many attributes of an existing asset using the explicit method, which is not rate-limited.

Example Usage

import { CloudinaryAssetMgmt } from "@cloudinary/asset-management";

const cloudinaryAssetMgmt = new CloudinaryAssetMgmt({
  cloudName: "<value>",
  security: {
    cloudinaryAuth: {
      apiKey: "CLOUDINARY_API_KEY",
      apiSecret: "CLOUDINARY_API_SECRET",
    },
  },
});

async function run() {
  const result = await cloudinaryAssetMgmt.assets.updateResourceByAssetId("f4e6579cf84dd9cf5683b21f5b30c7d9", {
    displayName: "My Product Image",
    assetFolder: "products/summer",
    tags: "product,summer,sale",
    context: "alt=My product image|caption=Summer collection",
    metadata: "in_stock_id=50|color_id=[\"green\",\"red\"]",
    faceCoordinates: "10,20,150,130|213,345,82,61",
    customCoordinates: "10,20,150,130|213,345,82,61",
    regions: "{\"name1\":[[1,2],[3,4]],\"name2\":[[5,6],[7,8],[9,10]]}",
    qualityOverride: "80:420",
    detection: "captioning",
    accessControl: [
      {
        accessType: "token",
        key: "prod2024",
      },
      {
        accessType: "anonymous",
        start: new Date("2024-03-15T09:00:00Z"),
        end: new Date("2024-06-30T23:59:59Z"),
      },
    ],
  });

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { CloudinaryAssetMgmtCore } from "@cloudinary/asset-management/core.js";
import { assetsUpdateResourceByAssetId } from "@cloudinary/asset-management/funcs/assetsUpdateResourceByAssetId.js";

// Use `CloudinaryAssetMgmtCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const cloudinaryAssetMgmt = new CloudinaryAssetMgmtCore({
  cloudName: "<value>",
  security: {
    cloudinaryAuth: {
      apiKey: "CLOUDINARY_API_KEY",
      apiSecret: "CLOUDINARY_API_SECRET",
    },
  },
});

async function run() {
  const res = await assetsUpdateResourceByAssetId(cloudinaryAssetMgmt, "f4e6579cf84dd9cf5683b21f5b30c7d9", {
    displayName: "My Product Image",
    assetFolder: "products/summer",
    tags: "product,summer,sale",
    context: "alt=My product image|caption=Summer collection",
    metadata: "in_stock_id=50|color_id=[\"green\",\"red\"]",
    faceCoordinates: "10,20,150,130|213,345,82,61",
    customCoordinates: "10,20,150,130|213,345,82,61",
    regions: "{\"name1\":[[1,2],[3,4]],\"name2\":[[5,6],[7,8],[9,10]]}",
    qualityOverride: "80:420",
    detection: "captioning",
    accessControl: [
      {
        accessType: "token",
        key: "prod2024",
      },
      {
        accessType: "anonymous",
        start: new Date("2024-03-15T09:00:00Z"),
        end: new Date("2024-06-30T23:59:59Z"),
      },
    ],
  });
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("assetsUpdateResourceByAssetId failed:", res.error);
  }
}

run();

Parameters

Parameter	Type	Required	Description	Example
`assetId`	string	✔️	The asset ID of the resource. Must be a 32-character hexadecimal string.	[object Object]
`resourceUpdateRequest`	components.ResourceUpdateRequest	✔️	N/A
`options`	RequestOptions	➖	Used to set various options for making HTTP requests.
`options.fetchOptions`	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed.
`options.retries`	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<components.Info>

Errors

Error Type	Status Code	Content Type
errors.ApiError	400, 401, 404	application/json
errors.SDKError	4XX, 5XX	/

listResourceTags

Retrieves a comprehensive list of all tags that exist in your product environment for assets of the specified type.

Cloudinary Admin API documentation

Example Usage

import { CloudinaryAssetMgmt } from "@cloudinary/asset-management";

const cloudinaryAssetMgmt = new CloudinaryAssetMgmt({
  cloudName: "<value>",
  security: {
    cloudinaryAuth: {
      apiKey: "CLOUDINARY_API_KEY",
      apiSecret: "CLOUDINARY_API_SECRET",
    },
  },
});

async function run() {
  const result = await cloudinaryAssetMgmt.assets.listResourceTags("raw");

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { CloudinaryAssetMgmtCore } from "@cloudinary/asset-management/core.js";
import { assetsListResourceTags } from "@cloudinary/asset-management/funcs/assetsListResourceTags.js";

// Use `CloudinaryAssetMgmtCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const cloudinaryAssetMgmt = new CloudinaryAssetMgmtCore({
  cloudName: "<value>",
  security: {
    cloudinaryAuth: {
      apiKey: "CLOUDINARY_API_KEY",
      apiSecret: "CLOUDINARY_API_SECRET",
    },
  },
});

async function run() {
  const res = await assetsListResourceTags(cloudinaryAssetMgmt, "raw");
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("assetsListResourceTags failed:", res.error);
  }
}

run();

Parameters

Parameter	Type	Required	Description
`resourceType`	components.ResourceType	✔️	The type of resource.
`prefix`	string	➖	The prefix to use if you want to limit the returned tags to those that start with the specified prefix.
`nextCursor`	string	➖	Cursor for pagination.
`maxResults`	number	➖	Maximum number of results to return (1-500).
`options`	RequestOptions	➖	Used to set various options for making HTTP requests.
`options.fetchOptions`	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed.
`options.retries`	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<operations.ListResourceTagsResponse>

Errors

Error Type	Status Code	Content Type
errors.ApiError	400, 401	application/json
errors.SDKError	4XX, 5XX	/

deleteBackupVersions

Deletes specific backed up versions of an asset identified by asset ID. This operation is irreversible and deleted versions cannot be recovered.

Example Usage

import { CloudinaryAssetMgmt } from "@cloudinary/asset-management";

const cloudinaryAssetMgmt = new CloudinaryAssetMgmt({
  cloudName: "<value>",
  security: {
    cloudinaryAuth: {
      apiKey: "CLOUDINARY_API_KEY",
      apiSecret: "CLOUDINARY_API_SECRET",
    },
  },
});

async function run() {
  const result = await cloudinaryAssetMgmt.assets.deleteBackupVersions("e9b44a374f66ad53a64a74c7398f7", {
    versionIds: [
      "5552aa57e67445552a3cdc1110a0115",
      "383e22a57167445552a3cdc16f0a0c85",
    ],
  });

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { CloudinaryAssetMgmtCore } from "@cloudinary/asset-management/core.js";
import { assetsDeleteBackupVersions } from "@cloudinary/asset-management/funcs/assetsDeleteBackupVersions.js";

// Use `CloudinaryAssetMgmtCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const cloudinaryAssetMgmt = new CloudinaryAssetMgmtCore({
  cloudName: "<value>",
  security: {
    cloudinaryAuth: {
      apiKey: "CLOUDINARY_API_KEY",
      apiSecret: "CLOUDINARY_API_SECRET",
    },
  },
});

async function run() {
  const res = await assetsDeleteBackupVersions(cloudinaryAssetMgmt, "e9b44a374f66ad53a64a74c7398f7", {
    versionIds: [
      "5552aa57e67445552a3cdc1110a0115",
      "383e22a57167445552a3cdc16f0a0c85",
    ],
  });
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("assetsDeleteBackupVersions failed:", res.error);
  }
}

run();

Parameters

Parameter	Type	Required	Description	Example
`assetId`	string	✔️	The asset ID of the resource. Must be a 32-character hexadecimal string.	[object Object]
`requestBody`	operations.DeleteBackupVersionsRequestBody	✔️	N/A
`options`	RequestOptions	➖	Used to set various options for making HTTP requests.
`options.fetchOptions`	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed.
`options.retries`	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<operations.DeleteBackupVersionsResponse>

Errors

Error Type	Status Code	Content Type
errors.ApiError	400, 401, 404	application/json
errors.SDKError	4XX, 5XX	/

derivedDestroy

Deletes derived resources by derived resource ID

Example Usage

import { CloudinaryAssetMgmt } from "@cloudinary/asset-management";

const cloudinaryAssetMgmt = new CloudinaryAssetMgmt({
  cloudName: "<value>",
  security: {
    cloudinaryAuth: {
      apiKey: "CLOUDINARY_API_KEY",
      apiSecret: "CLOUDINARY_API_SECRET",
    },
  },
});

async function run() {
  const result = await cloudinaryAssetMgmt.assets.derivedDestroy({
    derivedResourceIds: [
      "1234567890abcdef",
      "fedcba0987654321",
    ],
    invalidate: true,
  });

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { CloudinaryAssetMgmtCore } from "@cloudinary/asset-management/core.js";
import { assetsDerivedDestroy } from "@cloudinary/asset-management/funcs/assetsDerivedDestroy.js";

// Use `CloudinaryAssetMgmtCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const cloudinaryAssetMgmt = new CloudinaryAssetMgmtCore({
  cloudName: "<value>",
  security: {
    cloudinaryAuth: {
      apiKey: "CLOUDINARY_API_KEY",
      apiSecret: "CLOUDINARY_API_SECRET",
    },
  },
});

async function run() {
  const res = await assetsDerivedDestroy(cloudinaryAssetMgmt, {
    derivedResourceIds: [
      "1234567890abcdef",
      "fedcba0987654321",
    ],
    invalidate: true,
  });
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("assetsDerivedDestroy failed:", res.error);
  }
}

run();

Parameters

Parameter	Type	Required	Description	Example
`derivedResourceIds`	string[]	✔️	Array of derived resource IDs to delete specific derived resources	[object Object]
`invalidate`	boolean	➖	Whether to invalidate the CDN cache for the deleted resources	[object Object]
`options`	RequestOptions	➖	Used to set various options for making HTTP requests.
`options.fetchOptions`	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed.
`options.retries`	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<components.DerivedDestroyResponse>

Errors

Error Type	Status Code	Content Type
errors.ApiError	400, 401	application/json
errors.SDKError	4XX, 5XX	/

FilesExpand file tree

README.md

Latest commit

History

README.md

File metadata and controls

Assets

Overview

Available Operations

renameAsset

Example Usage

Standalone function

Parameters

Response

Errors

downloadAsset

Example Usage

Standalone function

Parameters

Response

Errors

explicitAsset

Example Usage

Standalone function

Parameters

Response

Errors

generateArchive

Example Usage

Standalone function

Parameters

Response

Errors

downloadBackupAsset

Example Usage

Standalone function

Parameters

Response

Errors

destroyByAssetId

Example Usage

Standalone function

Parameters

Response

Errors

listResourceTypes

Example Usage

Standalone function

Parameters

Response

Errors

listImages

Example Usage

Standalone function

Parameters

Response

Errors

listVideos

Example Usage

Standalone function

Parameters

Response

Errors

listRawFiles

Example Usage

Standalone function

Parameters

Response

Errors

listResourcesByAssetFolder

Example Usage

Standalone function

Parameters

Response

Errors

listResourcesByAssetIDs

Example Usage

Standalone function

Parameters

Response