Skip to main content
Server path: /cloudinary-organization | Type: Application | PCID required: Yes

Tools

ToolDescription
cloudinary_organization_assign_folder_rolesAssign folder roles
cloudinary_organization_create_folderCreates a new empty folder in your Cloudinary media library
cloudinary_organization_destroy_folderDeletes an existing folder from your media library
cloudinary_organization_get_folder_rolesGet folder roles
cloudinary_organization_get_personGet person details
cloudinary_organization_get_usageRetrieves comprehensive usage metrics and account statistics
cloudinary_organization_list_peopleList recognized people
cloudinary_organization_list_root_foldersGet root folders
cloudinary_organization_search_assetsProvides a powerful query interface to filter and retrieve assets and their details
cloudinary_organization_search_foldersSearches for folders whose attributes match a given expression
cloudinary_organization_search_folders_postSearches for folders in your product environment
cloudinary_organization_show_folderList sub-folders
cloudinary_organization_update_folderRenames or moves an entire folder (along with all assets it contains) to a new location
cloudinary_organization_update_personUpdate a person
cloudinary_organization_visual_search_assetsFinds images in your asset library based on visual similarity or content

cloudinary_organization_assign_folder_roles

Assign folder roles Parameters:
ParameterTypeRequiredDefaultDescription
folder_idstringYesThe immutable identifier of the folder, returned by the Get root folders and Get subfolders endpoints.
operationstringYesThe operation to perform on the principal’s role assignments. add grants the specified roles; remove revokes them.
principalobjectYesThe user, group, or API key whose role assignments are being modified.
rolesstring[]YesThe role IDs to add or remove.

cloudinary_organization_create_folder

Creates a new empty folder in your Cloudinary media library Parameters:
ParameterTypeRequiredDefaultDescription
folderstringYesThe path of the folder to operate on, including any nested folders.

cloudinary_organization_destroy_folder

Deletes an existing folder from your media library Parameters:
ParameterTypeRequiredDefaultDescription
folderstringYesThe path of the folder to operate on, including any nested folders.

cloudinary_organization_get_folder_roles

Get folder roles Parameters:
ParameterTypeRequiredDefaultDescription
folder_idstringYesThe immutable identifier of the folder, returned by the Get root folders and Get subfolders endpoints.
permitted_rolesbooleanNoWhether to include in the response the roles the authenticated user can assign on this folder, based on their permission level. Default: false.

cloudinary_organization_get_person

Get person details Parameters:
ParameterTypeRequiredDefaultDescription
person_idstringYesThe unique identifier of the person.

cloudinary_organization_get_usage

Retrieves comprehensive usage metrics and account statistics Parameters:
ParameterTypeRequiredDefaultDescription
datestringNoThe date for which to retrieve usage details. If not specified, returns the current month’s usage.

cloudinary_organization_list_people

List recognized people Parameters:
ParameterTypeRequiredDefaultDescription
max_resultsintegerNoThe maximum number of people to return. Default: 50.
next_cursorstringNoThe cursor for pagination. Use the next_cursor value from a previous response to get the next page of results.
name_statusstringNoFilter by whether the person has been named. Default: all.
name_prefixstringNoFilter people whose names start with the given prefix (case insensitive).
statusstringNoFilter by person status.
sort_bystringNoThe field to sort results by. Default: name (ascending).
directionstringNoThe sort direction for the results. Default is “desc”.

cloudinary_organization_list_root_folders

Get root folders

cloudinary_organization_search_assets

Provides a powerful query interface to filter and retrieve assets and their details Parameters:
ParameterTypeRequiredDefaultDescription
aggregateobjectNoThe aggregate value
expressionstringNoThe search expression. Supports exact match, wildcard match, presence, greater/less than, and range. For details on building expressions, see the Search API documentation.
fieldsstringNoA comma-separated list of fields to include in the response. Notes: - This parameter takes precedence over the with_field parameter, so if you want any additional asset attributes returned, make sure to also include them in this list (e.g., tags or context). - The following fields are always included in the response: public_id, asset_id, asset_folder, created_at, status, type, and resource_type.
max_resultsintegerNoThe maximum number of results to return. Default - 50. Maximum - 500.
next_cursorstringNoThe cursor value to get the next page of results. Available when a previous search returned more results than max_results.
sort_byobject[]NoAn array of single-key objects mapping a field to a sort direction. Each object must contain exactly one field name mapped to ‘asc’ or ‘desc’. Default: [{“created_at”: “desc”}].
with_fieldstring[]NoThe additional fields to include in the response. Note that the fields parameter takes precedence over this parameter.

cloudinary_organization_search_folders

Searches for folders whose attributes match a given expression Parameters:
ParameterTypeRequiredDefaultDescription
expressionobjectNoThe (Lucene-like) string expression specifying the search query, or an object for advanced queries. If not passed, returns all folders (up to max_results).
sort_bystring[]NoAn array of key-value pairs for sorting. Each value is a key and direction (asc/desc).
max_resultsintegerNoMaximum number of folders to return (max 500, default 50).
next_cursorstringNoThe cursor for pagination. Use the next_cursor value from a previous response to get the next page of results.

cloudinary_organization_search_folders_post

Searches for folders in your product environment Parameters:
ParameterTypeRequiredDefaultDescription
expressionstringNoThe (Lucene-like) string expression specifying the search query.
max_resultsintegerNoMaximum number of folders to return (max 500, default 50).
next_cursorstringNoWhen more results are available, use the next_cursor value from the previous response.
sort_bystring[]NoAn array of key-value pairs for sorting. Each value is a key and direction (asc/desc).

cloudinary_organization_show_folder

List sub-folders Parameters:
ParameterTypeRequiredDefaultDescription
folderstringYesThe path of the folder to operate on, including any nested folders.

cloudinary_organization_update_folder

Renames or moves an entire folder (along with all assets it contains) to a new location Parameters:
ParameterTypeRequiredDefaultDescription
folderstringYesThe path of the folder to operate on, including any nested folders.
to_folderstringYesThe new path for the folder.

cloudinary_organization_update_person

Update a person Parameters:
ParameterTypeRequiredDefaultDescription
person_idstringYesThe unique identifier of the person.
namestringNoThe display name for the person. Maximum 255 characters.
statusstringNoThe status of a person.
thumbnail_asset_idstringNoThe external ID of an asset containing this person’s face to use as the thumbnail.

cloudinary_organization_visual_search_assets

Finds images in your asset library based on visual similarity or content Parameters:
ParameterTypeRequiredDefaultDescription
bodyobjectYesParameters for visual search operations