Documentation and Tutorials
Features overview...

Django image upload

Overview

Cloudinary is a cloud-based service that provides an end-to-end image management solution including uploads, storage, administration, image manipulation, and delivery.

As part of its service, Cloudinary provides an API for uploading images and any other kind of files to the cloud. Images uploaded to Cloudinary are stored safely in the cloud with secure backups and revision history, utilizing Amazon's S3 service.

After you upload your images to Cloudinary, you can browse them using an API or an interactive web interface and manipulate them to reach the size and look & feel that best matches your graphic design. All uploaded images and dynamically transformed images are optimized and delivered by Cloudinary through a fast CDN with advanced caching for optimal user experience.

Cloudinary's APIs allow secure uploading images from your servers, directly from your visitors browsers or mobile applications, or fetched via remote public URLs. Comprehensive image transformations can be applied on uploaded images and you can extract images' metadata and semantic information once their upload completes.

Cloudinary's Python library wraps Cloudinary's upload API and simplifies the integration. Python methods are available for easily uploading images and raw files to the cloud. Django view helper methods are available for uploading images directly from a browser to Cloudinary.

This page covers common usage patterns for Django image upload with Cloudinary.

For a full list of Django image upload options, refer to All Upload Options.

Server side upload

You can upload images (or any other raw file) to Cloudinary from your Python code or Django server. Uploading is done over HTTPS using a secure protocol based on your account's api_key and api_secret parameters.

The following Python method uploads an image to the cloud:

def upload(file, **options)

For example, uploading a local image file named my_image.jpg:

cloudinary.uploader.upload("my_picture.jpg")

Uploading is performed synchronously. Once finished, the uploaded image is immediately available for manipulation and delivery.

An upload API call returns a Hash with content similar to that shown in the following example:

{   
  u'bytes': 29802,
  u'created_at': u'2013-06-25T17:20:30Z',
  u'format': u'jpg',
  u'height': 282,
  u'public_id': u'hl22acprlomnycgiudor',
  u'resource_type': u'image',
  u'secure_url': u'https://res.cloudinary.com/demo/image/upload/v1372180830/hl22acprlomnycgiudor.jpg',
  u'signature': u'10594f028dbc23e920fd084f8482394798edbc68',
  u'type': u'upload',
  u'url': u'http://res.cloudinary.com/demo/image/upload/v1372180830/hl22acprlomnycgiudor.jpg',
  u'version': 1372180830,
  u'width': 292
}

The response includes HTTP and HTTPS URLs for accessing the uploaded image as well as additional information regarding the uploaded file: The Public ID of the image (used for building viewing URLs), resource type, width and height, image format, file size in bytes, a signature for verifying the response and more.

Public ID

Each uploaded image is assigned with a unique identifier called Public ID. It is a URL-safe string that is used to reference the uploaded resource as well as building dynamic delivery and transformation URLs.

By default, Cloudinary generates a unique, random Public ID for each uploaded image. This identifier is returned in the public_id response parameter. In the example above, the assigned Public ID is 'hl22acprlomnycgiudor'. As a result, the URL for accessing this image via our 'demo' account is the following:

http://res.cloudinary.com/demo/image/upload/hl22acprlomnycgiudor.jpg

You can specify your own custom public ID instead of using the randomly generated one. The following example specifies 'sample_id' as the public ID:

cloudinary.uploader.upload("my_picture.jpg", public_id = 'sample_id')

Using a custom public ID is useful when you want your delivery URLs to be readable and refer to the associated entity. For example, setting the public ID to a normalized user name and identifier in your local system:

cloudinary.uploader.upload("my_picture.jpg", public_id = 'john_doe_1001')

Public IDs can be organized in folders for more structured delivery URLs. To use folders, simply separate elements in your public ID string with slashes ('/'). Here's an example:

cloudinary.uploader.upload("my_picture.jpg", public_id = 'my_folder/my_name')

As the example below shows, your public IDs can include multiple folders:

cloudinary.uploader.upload("my_picture.jpg", 
                           public_id = 'my_folder/my_sub_folder/my_name')

Set use_filename as true to tell Cloudinary to use the original name of the uploaded image file as its Public ID. Notice that the file name will be normalized and a set of random characters will be appended to it to ensure uniqueness. This is quite useful if you want to safely reuse the filenames of files uploaded directly by your users.

cloudinary.uploader.upload('sample.jpg', use_filename = True)

# Generated public ID for example: 'sample_apvz1t'

Data uploading options

Cloudinary's Python library supports uploading files from various sources.

You can upload an image by specifying a local path of an image file. For example:

cloudinary.uploader.upload('/home/my_image.jpg')

You can provide an IO object that you created:

cloudinary.uploader.upload(open('/tmp/image1.jpg', 'rb'))

If your images are already publicly available online, you can specify their remote HTTP URLs instead of uploading the actual data. In this case, Cloudinary will fetch the image from its remote URL for you. This option allows for a much faster migration of your existing images. Here's an example:

cloudinary.uploader.upload('http://www.example.com/image.jpg')

If you have existing images in an Amazon S3 bucket, you can point Cloudinary to their S3 URLs. Note - this option requires a quick manual setup. Contact us and we'll guide you on how to allow Cloudinary access to your relevant S3 buckets.

cloudinary.uploader.upload('s3://my-bucket/my-path/my-file.jpg')

In cases where images are uploaded by users of your Django application through a web form, you can pass the parameter of your Django's request.FILES to the upload method:

cloudinary.uploader.upload(request.FILES['file'])

Django forms and models

You can integrate Cloudinary's image uploading with your Django models and forms using Cloudinary's helper classes. As shown in the example below, you can define a model class Photo in your models.py file. This class has an image field of the CloudinaryField class.

from django.db import models
from cloudinary.models import CloudinaryField

class Photo(models.Model):
  image = CloudinaryField('image')

In the forms.py file we define a PhotoForm class that has a form field named image of the CloudinaryFileField class (in default).

from django.forms import ModelForm      
from .models import Photo

class PhotoForm(ModelForm):
  class Meta:
      model = Photo

The views.py file defines a view named upload which displays a HTML upload form and also handles posting of image files. Such images are uploaded to Cloudinary from your Django server by the CloudinaryFileField class.

from django import forms
from django.http import HttpResponse

from cloudinary.forms import cl_init_js_callbacks      
from .models import Photo
from .forms import PhotoDirectForm

def upload(request):
  context = dict( backend_form = PhotoForm())

  if request.method == 'POST':
    form = PhotoForm(request.POST, request.FILES)
    context['posted'] = form.instance
    if form.is_valid():
        form.save()

  return render(request, 'upload.html', context)

The following HTML templates includes a form that uploads images to your server for uploading to Cloudinary:

{% load cloudinary %}
{% load url from future %}

{% block body %}
  <div id='backend_upload'>
    <form action="{% url "photo_album.views.upload" %}" method="post"
          enctype="multipart/form-data">
      {% csrf_token %}
      {{ backend_form }}
      <input type="submit" value="Upload">
    </form>
{% endblock %}

Having stored the image ID, you can now embed the image or a transformed version of it using the cloudinary template tag:

{% load cloudinary %}      
{% cloudinary photo.image format="jpg" width=120 height=80 crop="fill" %}

In addition, you can assign tags, apply transformation or specify any Cloudinary's upload options when initializing the CloudinaryFileField class.

from django.forms import ModelForm      
from cloudinary.forms import CloudinaryFileField      
from .models import Photo

class PhotoForm(ModelForm):
  class Meta:
    model = Photo
  image = CloudinaryFileField(
            attrs = { 'style': "margin-top: 30px" }, 
            options = { 
              'tags': "directly_uploaded",
              'crop': 'limit', 'width': 1000, 'height': 1000,
              'eager' [{ 'crop': 'fill', 'width': 150, 'height': 100 }]
            })

Direct uploading from the browser

The upload samples mentioned above allows your server-side Django code to upload images to Cloudinary. In this flow, if you have a web form that allows your users to upload images, the image data is first sent to your server and only then uploaded to Cloudinary.

A more efficient and powerful option is to allow your users to upload images directly from the browser to Cloudinary instead of going through your servers. This method allows for faster uploading and better user experience. It also reduces load from your servers and reduces the complexity of your Django applications.

Uploading directly from the browser is done using Cloudinary's jQuery plugin. To ensure that all uploads were authorized by your application, a secure signature must first be generated in your server-side Python code.

Direct uploading environment setup

Start by including the required Javascript files - jQuery, Cloudinary's plugin and the jQuery-File-Upload plugin it depends on. These are located in the cloudinary/static folder of the Django library.

In your Django template, load Cloudinary and include jQuery and the required jQuery plugins:

{% load cloudinary %}
<script src="//ajax.googleapis.com/ajax/libs/jquery/1.8.3/jquery.min.js"></script>
{% cloudinary_includes %}

Cloudinary's jQuery plugin requires your cloud_name and additional configuration parameters to be available. Note: never expose your api_secret in public client side code.

To automatically set-up Cloudinary's configuration, include the following line in your view or layout:

{% cloudinary_js_config %}

Direct uploading from the browser is performed using XHR (Ajax XMLHttpRequest‎) CORS (Cross Origin Resource Sharing) requests. In order to support older browsers that do not support CORS, the jQuery plugin will gracefully degrade to an iframe based solution.

The file cloudinary_cors.html in automatically used to enable cross browser uploads when CORS is not supported. See cl_init_js_callbacks below.

Direct upload file tag

Cloudinary's direct uploading can be integrated with your Django model. Assuming you have the following Photo class defined in your models.py file. This class has an image field of the CloudinaryField class.

from django.db import models
from cloudinary.models import CloudinaryField

class Photo(models.Model):
  image = CloudinaryField('image')

In the forms.py file we define a PhotoDirectForm class that has a form field named image of the CloudinaryJsFileField class. This class does all the behind-the-scenes magic for you.

from django.forms import ModelForm      
from cloudinary.forms import CloudinaryJsFileField      
from .models import Photo

class PhotoDirectForm(ModelForm):
  class Meta:
      model = Photo
  image = CloudinaryJsFileField()

The views.py file defines a view named upload_prompt which initializes the direct form and defines the required callback URL:

from django import forms
from django.http import HttpResponse

from cloudinary.forms import cl_init_js_callbacks      
from .models import Photo
from .forms import PhotoDirectForm

def upload_prompt(request):
  context = dict(direct_form = PhotoDirectForm())
  cl_init_js_callbacks(context['direct_form'], request)
  return render(request, 'upload_prompt.html', context)

Embed a file input tag in your HTML templates using the cloudinary_direct_upload_field template tag or the direct_form you defined. The following example adds a file input field to your form. Selecting or dragging a file to this input field will automatically initiate uploading from the browser to Cloudinary.

<form action="{% url "photo_album.views.direct_upload_complete" %}" method="post">
  {% csrf_token %}
  {{ direct_form }}
  {# altenatively, use: {% cloudinary_direct_upload_field "image", request=request %} #}
  <input type="submit" value="Submit" />
</form>

When uploading is completed, the identifier of the uploaded image is set as the value of a hidden input field of your selected name.

You can then process the identifier received by your Django code and store it in your model for future use, exactly as if you're using a standard server side uploading.

The following Django code in views.py processes the received identifier, verifies the signature (concatenated to the identifier) and updates a model entity with the identifiers of the uploaded image (i.e., the Public ID and version of the image).

import json      
from django import forms
from django.http import HttpResponse
from django.views.decorators.csrf import csrf_exempt      
from .models import Photo
from .forms import PhotoDirectForm

...
    
@csrf_exempt
def direct_upload_complete(request):
  form = PhotoDirectForm(request.POST)
  if form.is_valid():
    form.save()
    ret = dict(photo_id = form.instance.id)
  else:
    ret = dict(errors = form.errors)
    
  return HttpResponse(json.dumps(ret), content_type='application/json')

Having stored the image ID, you can now display a directly uploaded image in the same way you would display any other Cloudinary hosted image:

{% load cloudinary %}      
{% cloudinary photo.image format="jpg" width=120 height=80 crop="fill" %}

Additional direct uploading options

When uploading directly from the browser, you can still specify all the upload options available to server-side uploading.

For example, the following call performs direct uploading that will also tag the uploaded image, limit its size to given dimensions and generate a thumbnail eagerly. Also notice the custom HTML attributes.

from django.forms import ModelForm      
from cloudinary.forms import CloudinaryJsFileField      
from .models import Photo

class PhotoDirectForm(ModelForm):
  class Meta:
    model = Photo
  image = CloudinaryJsFileField(
            attrs = { 'style': "margin-top: 30px" }, 
            options = { 
              'tags': "directly_uploaded",
              'crop': 'limit', 'width': 1000, 'height': 1000,
              'eager' [{ 'crop': 'fill', 'width': 150, 'height': 100 }]
            })

Preview thumbnail, progress indication, multiple images

Cloudinary's jQuery library also enables an enhanced uploading experience - show a progress bar, display a thumbnail of the uploaded image, drag & drop support, upload multiple files and more.

Bind to Cloudinary's cloudinarydone event if you want to be notified when an upload to Cloudinary has completed. You will have access to the full details of the uploaded image and you can display a cloud-generated thumbnail of the uploaded images using Cloudinary's jQuery plugin.

The following sample code creates a 150x100 thumbnail of an uploaded image and updates an input field with the public ID of this image.

$('.cloudinary-fileupload').bind('cloudinarydone', function(e, data) {  
  $('.preview').html(
    $.cloudinary.image(data.result.public_id, 
      { format: data.result.format, version: data.result.version, 
        crop: 'fill', width: 150, height: 100 })
  );    
  $('.image_public_id').val(data.result.public_id);    
  return true;
});

You can track the upload progress by binding to the following events: fileuploadsend, fileuploadprogress, fileuploaddone and fileuploadfail. You can find more details and options in the documention of jQuery-File-Upload.

The following Javascript code updates a progress bar according to the data of the fileuploadprogress event:

$('.cloudinary-fileupload').bind('fileuploadprogress', function(e, data) { 
  $('.progress_bar').css('width', Math.round((data.loaded * 100.0) / data.total) + '%'); 
});

You can find some more examples as well as an upload button style customization in our Photo Album sample project.

The file input field can be configured to support simultaneous multiple file uploading. Setting the multiple HTML parameter to true allows uploading multiple files. Note - currently, only a single input field is updated with the identifier of the uploaded image. You should manually bind to the cloudinarydone event to handle results of multiple uploads. Here's an example:

image = CloudinaryJsFileField(attrs = { 'multiple': 1 })

For a fully working example, check out our Django sample project.

For more details about direct uploading, see this blog post: Direct image uploads from the browser to the cloud with jQuery.

Incoming transformations

By default, images uploaded to Cloudinary are stored in the cloud as-is. Once safely stored in the Cloud, you can generate derived images from these originals by asking Cloudinary to apply transformations and manipulations.

Sometimes you may want to normalize and transform the original images before storing them in the cloud. You can do that by applying an incoming transformation as part of the upload request.

Any image transformation parameter can be specified as options passed to the upload call. A common incoming transformation use-case is shown in the following example, namely, limit the dimensions of user uploaded images to 1000x1000:

cloudinary.uploader.upload('/home/my_image.jpg', 
                            width = 1000, height = 1000, crop = 'limit')

Another example, this time performing custom coordinates cropping and forcing format conversion to PNG:

cloudinary.uploader.upload('/home/my_image.jpg', 
                            width = 400, height = 300,
                            x  = 50, y = 80, 
                            crop = 'crop', format = 'png')

Named transformations as well as multiple chained transformations can be applied using the transformation parameter. The following example first limits the dimensions of an uploaded image and then adds a watermark as an overlay.

cloudinary.uploader.upload('/home/my_image.jpg', 
    transformation = [
      { 'width': 1000, 'height': 1000, 'crop': 'limit' },
      { 'overlay': "my_watermark", 'flags': 'relative', 'width': 0.5 }
    ])

Eager transformations

Cloudinary can dynamically transform images using specially crafted transformation URLs. By default, the first time a user accesses a transformation URL, the transformed images is created on-the-fly, stored persistently in the cloud and delivered through a fast CDN with advanced caching. All subsequent accesses to the same transformation would quickly deliver a cached copy of the previously generated image via the CDN.

You can tell Cloudinary to eagerly generate one or more derived images while uploading. This approach is useful when you know in advance that certain transformed versions of your uploaded images will be required. Eagerly generated derived images are available for fast access immediately when the upload call returns.

Generating transformed images eagerly is done by specifying the `eager` upload option. This option accepts either a hash of transformation parameters or an array of transformations.

The following example eagerly generates a 150x100 face detection based thumbnail:

cloudinary.uploader.upload('/home/my_image.jpg', public_id = "eager_sample",
                            eager = { 'width': 150, 'height': 100, 
                                      'crop': 'thumb', 'gravity': 'face' })

Now, if you embed the same transformed image in your web view, it will already be available for fast delivery. The following tag embeds the derived image from the example above:

cloudinary.CloudinaryImage("eager_sample.jpg").image(width = 150, height = 100, 
                                                     crop = 'thumb', grvity = 'face')

The following example generates two transformed versions eagerly, one fitting image into a 100x150 PNG and another applies a named transformation.

cloudinary.uploader.upload('/home/my_image.jpg', 
                            eager = [
                              {'width': 100, 'height': 150, 
                               'crop': 'fit', 'format': 'png'}, 
                              {'transformation': 'jpg_with_quality_30'}
                            ])

You can apply an incoming transformation and generate derived images eagerly using the same upload call. The following example does that while also applying a chained transformation:

cloudinary.uploader.upload("sample.jpg", 
    transformation = [
      {'width': 100, 'height': 120, 'crop': 'limit'}, 
      {'crop': 'crop', 'x': 5, 'y': 10, 'width': 40, 'height': 10}
     ],
    eager = [
      {'width': 0.2, 'crop': 'scale'}, 
      {'effect': 'hue:30'}
     ])

For more image transformation options in Django, see Django image manipulation.

Semantic data extraction

When you upload a resource to Cloudinary, the API call will report information about the uploaded asset: width, height, number of bytes and image format. Cloudinary supports extracting additional information from the uploaded image: Exif and IPTC camera metadata, color histogram, predominant colors and coordinates of automatically detected faces. You can ask Cloudinary for this semantic data either during the upload API call for newly uploaded images, or using our Admin API for previously uploaded images.

See Cloudinary's Admin API documentation for more details: Details of a single resource.

You can tell Cloudinary to include relevant metadata in its upload API response by setting the faces, exif, colors and image_metadata boolean parameters to true while calling the upload API.

The following example uploads an image via a remote URL, and requests the coordinates of all detected faces in the image:

cloudinary.uploader.upload("http://res.cloudinary.com/demo/image/upload/couple.jpg", 
                            faces = True)

Below you can see the faces coordinates that were included in the upload response:

{   
  u'public_id': u'b2sajypsvfcdnxk3licr',
  ...
  u'faces': [[98, 74, 61, 83], [139, 130, 52, 71]]
}

Another example, this time requesting details about the main colors of the uploaded image. Each pair in the returned colors array includes the color name or its RGB representation and the percentage of the image comprising it.

cloudinary.uploader.upload("http://res.cloudinary.com/demo/image/upload/couple.jpg", 
                            colors = True)  

# Output: 
{   
  u'public_id': u'ipnmreyakj0n0tdggfq4',    
  ...  
  u'colors': [   
    [u'#152E02', 7.9], [u'#2E4F06', 6.3], [u'#3A6604', 5.6], [u'#EEF2F3', 5.2],
    [u'#598504', 4.6], [u'#0D1903', 4.6], [u'#DCDFDB', 4.4], [u'#7AA403', 3.9],
    [u'#DBE98A', 3.8], [u'#4C7208', 3.5], [u'#8DAC30', 3.3], [u'#6C9406', 3.2],
    [u'#6E912F', 3.2], [u'#B0C95F', 3.1], [u'#89AF07', 3.1], [u'#9E744E', 2.9],
    [u'#CD9A6F', 2.8], [u'#D8B395', 2.5], [u'#719357', 2.4], [u'#ACCDBC', 2.3],
    [u'#8E6437', 2.3], [u'#E2E0A0', 2.3], [u'#2C4B16', 2.3], [u'#656950', 2.1],
    [u'#25370A', 2.0], [u'#73A092', 1.9], [u'#4E3721', 1.6], [u'#A0AD9A', 1.6],
    [u'#BBD258', 1.5], [u'#5B602B', 1.3], [u'#302B1D', 1.3], [u'#9CA25C', 1.2]],
  u'predominant': {   u'google': [   [u'yellow', 40.1],
                                     [u'green', 24.6],
                                     [u'brown', 13.4],
                                     [u'black', 12.5],
                                     [u'teal', 9.4]]}
}

You can also request Exif, IPTC, colors and faces data in a single upload call:

cloudinary.uploader.upload("/home/my_image.jpg", 
                            faces = True, exif = True, 
                            colors = True, image_metadata = True)

See the following blog post for more details: API for extracting semantic image data - colors, faces, Exif data and more

Raw file uploading

Cloudinary's main strength is in managing images. However, you can still use Cloudinary to manage any other file format using the same simple APIs. You'll get your files stored in a highly available storage with automatic backups and revision control, and when accessed, have them delivered through a fast CDN.

You can upload a raw file to Cloudinary by setting the resource_type parameter to raw.

cloudinary.uploader.upload("sample_spreadsheet.xls", 
                            public_id = "sample_spreadsheet",
                            resource_type = 'raw')

Non-image raw files are stored in the cloud as-is. Note that while public IDs of image files do not include the file's extension, public IDs of raw files does include the original file's extension.

Here's a sample response of a raw upload call, which is slightly different from an image upload response:

{   
  u'bytes': 6144,
  u'created_at': u'2013-06-23T14:55:21Z',
  u'public_id': u'sample_spreadsheet.xls',
  u'resource_type': u'raw',
  u'secure_url': u'https://res.cloudinary.com/demo/raw/upload/v1372186255/sample_spreadsheet.xls',
  u'signature': u'2985c846b8ea5b0a280910a5f3b9d1cfec685f25',
  u'type': u'upload',
  u'url': u'http://res.cloudinary.com/demo/raw/upload/v1372186255/sample_spreadsheet.xls',
  u'version': 1372186255
}

Sometimes you don't know whether your users would upload image files or raw files. In order to support that, you can set the resource_type parameter to auto. Cloudinary will automatically detect whether the uploaded file is an image or a non-image raw file. When using direct image uploading from the browser, resource type is set to auto by default.

cloudinary.uploader.upload("sample_spreadsheet.xls", 
                            resource_type = 'auto')

Delivery URLs of raw files are built quite similarly to those of images. Just make sure to set resource_type to raw. Here's an example:

cloudinary.utils.cloudinary_url("sample_spreadsheet.xls", resource_type = 'raw')

Update and delete images

Image uploaded to Cloudinary are stored persistently in the cloud. You can programatically delete an uploaded image using the following method:

def destroy(public_id, **options)

For example, the following code would delete the uploaded image assigned with the public ID 'zombie':

cloudinary.uploader.destroy('zombie')

See our Admin API documentation for more options of listing and deleting images and files.

When you delete an uploaded image, all its derived images are deleted as well. However, images and derived images that were already delivered to your users might have cached copies at the CDN layer. If you now upload a new image with the same public ID, the cached copy might be returned instead. To avoid that, use different randomly generated public IDs for each upload or alternatively, add the version component to the delivery URLs. If none of these solutions work, you might want to force cache invalidation for each deleted image.

Forcing cache invalidation is done by setting the invalidate parameter to true either when deleting an image or uploading a new one. Note that it usually takes up to one hour for the CDN invalidation to take effect. Here's are two examples:

cloudinary.uploader.destroy('zombie', invalidate = True)
cloudinary.uploader.upload('new_zombie.jpg', 
                           public_id = 'zombie', invalidate = True)

Refresh images

Cloudinary supports forcing the refresh of Facebook & Twitter profile pictures. You can use the explicit API method for that. The response of this method includes the image's version. Use this version to bypass previously cached CDN copies.

cloudinary.uploader.explicit("zuck", type = "facebook")

You can also use the explicit API call to generate transformed versions of an uploaded image. This is useful when Strict Transformations are allowed for your account and you wish to create custom derived images for already uploaded images.

cloudinary.uploader.explicit("sample_id", type = 'upload', 
                             eager = { 'width': 150, 'height': 230, 'crop': 'fill' } )

Rename images

You can rename images uploaded to Cloudinary. Renaming means changing the public ID of already uploaded images. The following method allows renaming a public ID:

def rename(from_public_id, to_public_id, **options)

For example, renaming an image with the public ID 'old_name' ro 'new_name':

cloudinary.uploader.rename('old_name', 'new_name')

By default, Cloudinary prevents renaming to an already taken public ID. You can set the overwrite option to true to delete the image that has the target public ID and replace it with the image being renamed:

cloudinary.uploader.rename('old_name', 'new_name', overwrite = true)

Manage tags

Cloudinary supports assigning one or more tags to uploaded images. Tags allow you to better organize your media library.

You can use our Admin API and media library web interface for searching, listing and deleting images by tags. In addition, you can merge multiple images that share the same tag into a sprite, a multi-page PDF or an animated GIF.

See our Admin API documentation for more details regarding managing images by tags.

The following example assigned two tags while uploading.

cloudinary.uploader.upload('/home/my_image.jpg', public_id = "sample_id",
                           tags = ['special', 'for_homepage'])

You can modify the assigned tags of an already uploaded image. The following example assigns a tag to a list of images:

cloudinary.uploader.add_tag('another_tag', 
                            ['sample_id', 'de9wjix4hhnqpxixq6cw'])

The following example clears the given tag from a list of images:

cloudinary.uploader.remove_tag('another_tag',
                               ['sample_id', 'de9wjix4hhnqpxixq6cw'])

This example clears all tags from a given list of images:

cloudinary.uploader.replace_tag('another_tag', ['sample_id'])

Text creation

Cloudinary allows generating dynamic text overlays with your custom text. First you need to create a text style - font family, size, color, etc. The name of the text style is its public ID and it behaves like an image of the text type.

The following command creates a text style named dark_name of a certain font, color and style:

cloudinary.uploader.text("Sample Name",
                         public_id = 'dark_name',
                         font_family = 'Arial', font_size = 12,
                         font_color = 'black', opacity = 90)

The following image tag adds a text overlay using the created dark_name text style.

cloudinary.CloudinaryImage("sample.jpg").image( 
             overlay = "text:bold_dark:Hello+World", 
             gravity = "south_east", x = 5, y = 5)

For more text style options, see Text layers creation.

More information about text overlays is available in our adding text overlays in Django documentation.

Notifications and async transformations

By default, Cloudinary's upload API works synchronously. Uploaded images processed and eager transformations are generated synchronously during the upload API call.

You can tell Cloudinary to generate eager transformations in the background and send you an HTTP notification callback when the transformations are ready. You can do that by setting the eager_async parameter to true and optionally setting eager_notification_url to the URL Cloudinary should send the callback to. Here's an example:

cloudinary.uploader.upload('/home/my_image.jpg', 
              eager = { 'width': 150, 'height': 100, 
                        'crop': 'thumb', 'gravity':'face' },
              eager_async = True, 
              eager_notification_url = "http://mysite/my_notification_endpoint")

Cloudinary also supports webhooks. With webhooks enabled, you can get a notification to your server when an upload is completed. This is useful when you use direct image uploading from the browser and you want to be informed whenever an image is uploaded by your users. Setting the notification_url parameter tells Cloudinary to perform an asynchronous HTTP GET request to your server when the upload is complete. For example:

cloudinary.uploader.upload('/home/my_image.jpg',
                            notification_url = "http://mysite/my_notification_endpoint")

See the following blog post for more details: Webhooks, upload notifications and background image processing.

All upload options

cloudinary.uploader.upload(file, options = {})

Cloudinary's upload API call accepts the following options:

  • file - The resource to upload. Can be one of the following:
    • A local path (e.g., '/home/my_image.jpg').
    • An HTTP URL of a resource available on the Internet (e.g., 'http://www.example.com/image.jpg').
    • A URL of a file in a private S3 bucket white-listed for your account (e.g., 's3://my-bucket/my-path/my-file.jpg')
    • An IO input stream of the data (e.g., open(file, 'rb')).
  • public_id (Optional) - Public ID to assign to the uploaded image. Random ID is generated otherwise and returned as a result for this call. The public ID may contain a full path including folders separated by '/'.
  • tags (Optional) - A tag name or an array with a list of tag names to assign to the uploaded image.
  • context - A map of key-value pairs of general textual context metadata to attach to an uploaded resource. The context values of uploaded files are available for fetching using the Admin API. For example: { "alt" => "My image", "caption" => "Profile Photo" }.
  • format (Optional) - A format to convert the uploaded image to before saving in the cloud. For example: 'jpg'.
  • allowed_formats - A format name of an array of file formats that are allowed for uploading. The default is any supported image kind and any type of raw file. Files of other types will be rejected. The formats can be image types or raw file extensions. For example: ['jpg', 'gif' , 'doc'].
  • Transformation parameters (Optional) - Any combination of transformation-related parameters for transforming the uploaded image before storing in the cloud. For example: 'width', 'height', 'crop', 'gravity', 'quality', 'transformation'.
  • eager (Optional) - A list of transformations to generate for the uploaded image during the upload process, instead of lazily creating these on-the-fly on access.
  • eager_async (Optional, Boolean) - Whether to generate the eager transformations asynchronously in the background after the upload request is completed rather than online as part of the upload call. Default: false.
  • resource_type (Optional) - Valid values: 'image', 'raw' and 'auto'. Default: 'image'.
  • type (Optional) - Allows uploading images as 'private' or 'authenticated'. Valid values: 'upload', 'private' and 'authenticated'. Default: 'upload'.
  • headers (Optional) - An HTTP header or an array of headers for returning as response HTTP headers when delivering the uploaded image to your users. Supported headers: 'Link', 'X-Robots-Tag'. For example 'X-Robots-Tag: noindex'.
  • callback (Optional) - An HTTP URL to redirect to instead of returning the upload response. Signed upload result parameters are added to the callback URL. Ignored if it is an XHR upload request (Ajax XMLHttpRequest).
  • notification_url (Optional) - An HTTP URL to send notification to (a webhook) when the upload is completed.
  • eager_notification_url (Optional) - An HTTP URL to send notification to (a webhook) when the generation of eager transformations is completed.
  • backup (Optional, Boolean) - Tell Cloudinary whether to back up the uploaded image. Overrides the default backup settings of your account.
  • return_delete_token (Boolean) - Whether to return a deletion token in the upload response. The token can be used to delete the uploaded image within 10 minutes using an unauthenticated API request.
  • faces (Optional, Boolean) - Whether to retrieve a list of coordinates of automatically detected faces in the uploaded photo. Default: false.
  • exif (Optional, Boolean) - Whether to retrieve the Exif metadata of the uploaded photo. Default: false.
  • colors (Optional, Boolean) - Whether to retrieve predominant colors & color histogram of the uploaded image. Default: false.
  • image_metadata (Optional, Boolean) - Whether to retrieve IPTC and detailed Exif metadata of the uploaded photo. Default: false.
  • phash (Optional, Boolean) - Whether to return the perceptual hash (pHash) on the uploaded image. The pHash acts as a fingerprint that allows checking image similarity. Default: false.
  • invalidate (Optional, Boolean) - Whether to invalidate CDN cache copies of a previously uploaded image that shares the same public ID. Default: false.
  • use_filename (Optional, Boolean) - Whether to use the original file name of the uploaded image if available for the public ID. The file name is normalized and random characters are appended to ensure uniqueness. Default: false.
  • unique_filename (Optional, Boolean) - Only relevant if use_filename is true. When set to false, should not add random characters at the end of the filename that guarantee its uniqueness. Default: true.
  • folder - An optional folder name where the uploaded resource will be stored. The public ID contains the full path of the uploaded resource, including the folder name.
  • overwrite (Optional, Boolean) - Whether to overwrite existing resources with the same public ID. When set to false, return immediately if a resource with the same public ID was found. Default: true.
  • discard_original_filename (Optional, Boolean) - Whether to discard the name of the original uploaded file. Relevant when delivering images as attachments (setting the 'flags' transformation parameter to 'attachment'). Default: false.
  • face_coordinates (Optional, Array) - List of coordinates of faces contained in an uploaded image. The given coordinates are used for cropping uploaded images using the face or faces gravity mode. The specified coordinates override the automatically detected faces. Each face is specified by the X & Y coordinates of the top left corner and the width & height of the face. For example: [[10,20,150,130], [213,345,82,61]].
  • custom_coordinates (Optional, Array) - Coordinates of an interesting region contained in an uploaded image. The given coordinates are used for cropping uploaded images using the custom gravity mode. The region is specified by the X & Y coordinates of the top left corner and the width & height of the region. For example: [85,120,220,310].
  • raw_convert - Set to 'aspose' to automatically convert Office documents to PDF files and other image formats using the Aspose Document Conversion add-on.
  • categorization - Set to 'rekognition_scene' to automatically detect scene categories of photos using the ReKognition Scene Categorization add-on.
  • auto_tagging (0.0 to 1.0 Decimal number) - Whether to assign tags to an image according to detected scene categories with confidence score higher than the given value.
  • detection - Set to 'rekognition_face' to automatically extract advanced face attributes of photos using the ReKognition Detect Face Attributes add-on.
  • moderation - Set to 'manual' to add the uploaded image to a queue of pending moderation images. Set to 'webpurify' to automatically moderate the uploaded image using the WebPurify Image Moderation add-on.
  • upload_preset - Name of an upload preset that you defined for your Cloudinary account. An upload preset consists of upload parameters centrally managed using the Admin API or from the settings page of the management console. An upload preset may be marked as 'unsigned', which allows unsigned uploading directly from the browser and restrict the directly allowed parameters to: public_id, folder, tags, context, face_coordinates and custom_coordinates.