References
Last updated: Mar-29-2023
The references below provide you with complete syntax for all available APIs and corresponding SDK methods, as well as parameter details, useful code examples, and sample response data.
When learning about Cloudinary features for the first time, these references should be used in conjunction with the relevant Guides, which provide more information on how each feature works, examples or walk-throughs of real-life use cases, how various features can be used together, important notes, tips, and considerations, and more.
URL and REST APIs
Transformation URL API
Details all available URL transformation parameters for both images and videos, complete syntax details plus URL & SDK code examples.
Upload API
Details the (non-rate-limited) REST API endpoints and corresponding SDK methods for uploading and managing individual assets.
Admin API
Details the (rate-limited) REST API endpoints and corresponding SDK methods for bulk management of media assets and other product environment entities.
Search API
Covers all options available using the `search` API method to find, filter and retrieve information on the assets in your product environment using Lucene-like query expressions.
Metadata API
Covers all details of the `metadata` API method, including metadata field structure, datasource value structure, and adding value validation to fields.
Provisioning API
Details the REST API endpoints and corresponding SDK methods for creating and managing product environments, users and user groups.
Take advantage of our Cloudinary Postman Collections to experiment with our REST APIs and view the responses before adding them to your own code.
For details on setting up your own fork of our collections and configuring your Postman environment with your Cloudinary product environment credentials, see Using Cloudinary Postman collections.
CLI and SDK references
Cloudinary CLI Reference
Describes how to interact with Cloudinary via command-line, enabling you to perform Admin and Upload API operations without a dedicated backend environment, as well as additional helper commands.
Transformation Builder (url-gen) SDK Reference
Details Cloudinary's internal Transformation Builder SDK that allows you to generate transformations for @cloudinary/url-gen in React, Vue, Angular and Javascript.
React SDK Reference
Details Cloudinary's React frontend framework library that provides image rendering capabilities and plugins.
Vue SDK Reference
Details Cloudinary's Vue.js frontend framework library that provides image rendering capabilities and plugins.
Angular SDK Reference
Details Cloudinary's Angular frontend framework library that provides image rendering capabilities and plugins.
Javascript SDK Reference
Details Cloudinary's JavaScript SDK that provides simple yet comprehensive image and video transformation, optimization, and delivery capabilities.
PHP SDK Reference
Details Cloudinary's PHP SDK that provides simple yet comprehensive image and video upload, transformation, optimization, and delivery capabilities.
Go SDK Reference
Details Cloudinary's Go SDK that provides simple yet comprehensive media upload and management capabilities, and asset delivery URL generation.
Widget and Player libraries
Upload Widget API
Details the methods, parameters and events that you can use to customize and embed the Cloudinary Upload widget in your app.
Product Gallery API
Details the methods, parameters, enums and events that you can use when implementing the Cloudinary Product Gallery for your site.
Media Editor API
Details the parameter options, types and events that you can use to configure and customize the Media Editor widget.
Video Player API
Details the methods, parameters, attributes and events that you can use when working with the Cloudinary video player.
Error
Rate this page:
