Node.js SDK

The Cloudinary Node.js SDK provides simple, yet comprehensive image and video upload, transformation, optimization, and delivery capabilities through the Cloudinary APIs, that you can implement using code that integrates seamlessly with your existing Node.js application.

How would you like to learn?

Resource	Description
Node.js quick start	Get up and running in five minutes with a walk through of installation, configuration, upload, management and transformations.
Video tutorials	Watch tutorials relevant to your use cases, from getting started with the Node.js SDK, to uploading, transforming and analyzing your images and videos.
Sample projects	Explore sample projects to see how to implement Cloudinary functionality such as upload and delivery with transformations.
Cloudinary Node.js SDK GitHub repo	Explore the source code and see the CHANGELOG for details on all new features and fixes from previous versions.
	Try the free Introduction to Cloudinary for Node.js Developers online course, where you can learn how to upload, manage, transform and optimize your digital assets.

On this page:

• How would you like to learn?
• Install
• Configure
  • Set required configuration parameters
  • Set additional configuration parameters
  • Configuration video tutorials
• Use
  • Quick example: File upload
  • Quick example: Transform and optimize
  • Quick example: Get details of a single asset
• Sample projects

Rate this page:

Install

Cloudinary's Node.js integration library is available as an open-source NPM package. To install the library, run:

npm install cloudinary

Configure

Include Cloudinary's Node.js classes in your code:

const cloudinary = require('cloudinary');

const cloudinary = require('cloudinary').v2;

import { v2 as cloudinary } from 'cloudinary'

cloudinary.uploader
  .upload("my_image.jpg")
  .then(result=>console.log(result));

Set required configuration parameters

You can set the required configuration parameters, cloud_name, api_key and api_secret either using the CLOUDINARY_URL environment variable, or using the config method in your code.

To define the CLOUDINARY_URL environment variable:

1. Copy the API environment variable format from the API Keys page of the Cloudinary Console Settings.
2. Replace <your_api_key> and <your_api_secret> with your actual values. Your cloud name is already correctly included in the format.

For example:

CLOUDINARY_URL=cloudinary://my_key:my_secret@my_cloud_name

Alternatively, you can use the config method to set your cloud_name, api_key and api_secret, for example:

cloudinary.config({ 
  cloud_name: 'my_cloud_name', 
  api_key: 'my_key', 
  api_secret: 'my_secret'
});

Set additional configuration parameters

In addition to the required configuration parameters, you can define a number of optional configuration parameters if relevant.

You can append configuration parameters, for example upload_prefix and secure_distribution, to the environment variable:

CLOUDINARY_URL=cloudinary://my_key:my_secret@my_cloud_name?secure_distribution=mydomain.com&upload_prefix=https://api-eu.cloudinary.com

Or you can use the config method in your code, for example:

cloudinary.config({ 
  cloud_name: 'my_cloud_name', 
  api_key: 'my_key', 
  api_secret: 'my_secret',
  secure_distribution: 'mydomain.com',
  upload_prefix: 'https://api-eu.cloudinary.com'
});

Configuration video tutorials

The following tutorials can help you install and set up your SDK:

See more Node.js video tutorials.

Use

Once you've installed and configured the Node.js SDK, you can use it for:

• Uploading files to your product environment: You can upload any files, not only images and videos, set your own naming conventions and overwrite policies, moderate and tag your assets on upload, and much more. See example
• Transforming and optimizing images and videos: Keeping your original assets intact in your product environment, you can deliver different versions of your media - different sizes, formats, with effects and overlays, customized for your needs. See example
• Managing assets: Using methods from the Admin and Upload APIs, you can organize your assets, for example, list, rename and delete them, add tags and metadata and use advanced search capabilities. See example

Quick example: File upload

The following Node.js code uploads the dog.mp4 video using the public_id, my_dog. The video overwrites the existing my_dog video if it exists. When the video upload finishes, the specified notification URL receives details about the uploaded media asset.

cloudinary.v2.uploader
.upload("dog.mp4", {
  resource_type: "video", 
  public_id: "my_dog",
  overwrite: true, 
  notification_url: "https://mysite.example.com/notify_endpoint"})
.then(result=>console.log(result));

Quick example: Transform and optimize

Take a look at the following transformation code and the image it delivers:

cloudinary.image("front_face.png", {transformation: [
  {gravity: "face", height: 150, width: 150, crop: "thumb"},
  {radius: 20},
  {effect: "sepia"},
  {overlay: "cloudinary_icon"},
  {effect: "brightness:90"},
  {opacity: 60},
  {width: 50, crop: "scale"},
  {flags: "layer_apply", gravity: "south_east", x: 5, y: 5},
  {angle: 10},
  {quality: "auto"}
  ]})

This relatively simple code performs all of the following on the original front_face.jpg image before delivering it:

• Crop to a 150x150 thumbnail using face-detection gravity to automatically determine the location for the crop
• Round the corners with a 20 pixel radius
• Apply a sepia effect
• Overlay the Cloudinary logo on the southeast corner of the image (with a slight offset). Scale the logo overlay down to a 50 pixel width, with increased brightness and partial transparency (opacity = 60%).
• Rotate the resulting image (including the overlay) by 10 degrees
• Optimize the image to reduce the size of the image without impacting visual quality.
• Convert and deliver the image in PNG format (the originally uploaded image was a JPG)

And here's the URL that's automatically generated and included in an image tag from the above code:

https://res.cloudinary.com/demo/image/upload/c_thumb,g_face,h_150,w_150/r_20/e_sepia/l_cloudinary_icon/e_brightness:90/o_60/c_scale,w_50/fl_layer_apply,g_south_east,x_5,y_5/a_10/q_auto/front_face.png

In a similar way, you can transform a video.

Quick example: Get details of a single asset

The following Node.js example uses the Admin API resource method to return details of the image with public ID cld-sample:

cloudinary.v2.api
  .resource('cld-sample')
  .then(result=>console.log(result));

Sample output:

{
  "asset_id": "bf98540caf22ed65775ee0951f4746c9",
  "public_id": "cld-sample",
  "format": "jpg",
  "version": 1719304891,
  "resource_type": "image",
  "type": "upload",
  "created_at": "2024-06-25T08:41:31Z",
  "bytes": 476846,
  "width": 1870,
  "height": 1250,
  "backup": true,
  "asset_folder": "",
  "display_name": "cld-sample",
  "url": "http://res.cloudinary.com/cld-docs/image/upload/v1719304891/cld-sample.jpg",
  "secure_url": "https://res.cloudinary.com/cld-docs/image/upload/v1719304891/cld-sample.jpg",
  "next_cursor": "497b323dcb9883a15a5e6a7cfb75d439e4de1ca882f5cbe8de6a8b322c37bdad",
  "derived": [
    {
      "transformation": "c_scale,w_500",
      "format": "jpg",
      "bytes": 22871,
      "id": "ce3d7bf3068809656dc5aa76572535da",
      "url": "http://res.cloudinary.com/cld-docs/image/upload/c_scale,w_500/v1719304891/cld-sample.jpg",
      "secure_url": "https://res.cloudinary.com/cld-docs/image/upload/c_scale,w_500/v1719304891/cld-sample.jpg"
    }
  ]
}

Sample projects

Take a look at the Node.js sample projects page to help you get started integrating Cloudinary into your Node.js application.