Cloudinary

Upload and transform images and media with Cloudinary.

On this page

Connect
Call it from a workflow
Actions (5)
transformResource
createUsageReport
deleteResource
findResourceByPublicId
uploadResource
Details

Connect

Auth type: API key (secret_text). Paste the API key (or token) from the provider's settings into the connect dialog. It is encrypted at rest and only decrypted on the server when an action runs.

In the editor: Backend panel, Integrations tab, then Connect. This connects it for the project.
For every project in a workspace: Workspace settings, Integrations.
Owners and admins choose which integrations members may connect in the admin panel (Integrations tab), and can attach their own OAuth app there.

Call it from a workflow

Pass the action name and its input. The call resolves with { success, output, error? }; a missing connection resolves with success false and the reason. See ctx.integrations.invoke and ctx.integrations.call.

Native workflow

// .workflow.js (native ctx)
export async function run(ctx) {
  const res = await ctx.integrations.invoke("cloudinary", "transformResource", {
    "resource_type": "<resource_type>"
  });
  if (!res.success) throw new Error(res.error);
  ctx.log.info("Cloudinary answered", { output: res.output });
}

defineWorkflow module

// defineWorkflow module (@app/sdk ctx)
import { defineWorkflow } from "@app/sdk";

export default defineWorkflow({
  id: "cloudinary-transformresource",
  name: "Cloudinary: Transform Resource",
  description: "Calls Cloudinary when a row is created.",
  trigger: { type: "entity_event", entity: "tickets", event: "created" },
  async run(ctx, event) {
    const res = await ctx.integrations.call("cloudinary", {
      "action": "transformResource",
      "resource_type": "<resource_type>"
    }) as { success: boolean; error?: string };
    if (!res.success) throw new Error(res.error);
  },
});

From an app (connector proxy)

curl -X POST "$APP_ORIGIN/__appbricx/connector-proxy/cloudinary/transformResource" \
  -H "Authorization: Bearer $APP_KEY" \
  -H "content-type: application/json" \
  -d '{"props":{"resource_type":"<resource_type>"}}'

Actions

transformResourcein catalog

Transform Resource. Apply transformations (resize, crop, watermark, etc.) to an asset and generate a new URL.

Input	Type	Description
`resource_type`required	id (picked from your account)	Select the type of resource to upload to Cloudinary.
`public_ids_dropdown`optional	ids (picked from your account)	Select assets to delete by their public IDs
`public_id_manual`optional	text	Or enter public ID manually if not in dropdown
`width`optional	number	Target width in pixels
`height`optional	number	Target height in pixels
`crop_mode`optional	one of "scale" \| "fill" \| "fit" \| "crop" \| "thumb" \| "limit"	How to handle resizing when aspect ratios differ
`gravity`optional	one of "auto" \| "face" \| "center" \| "north" \| "south" \| "east" \| "west" \| "north_west" \| "north_east" \| "south_west" \| "south_east"	Which part to focus on when cropping
`format`optional	one of "auto" \| "jpg" \| "png" \| "webp" \| "avif" \| "gif" \| "svg"	Convert to this format
`quality`optional	one of "auto" \| "90" \| "80" \| "70" \| "50"	Image quality/compression level
`border`optional	text	Add border (e.g., "5px_solid_blue", "10px_solid_#ff0000")
`radius`optional	one of "10" \| "20" \| "50" \| "max"	Round corners or make circular
`opacity`optional	number	Transparency level (0-100, where 100 is opaque)
`rotation`optional	number	Rotate image by degrees (0-360)
`raw_transformation`optional	long text	Advanced: Raw transformation string (e.g., "c_fill,w_300,h_200/e_sepia/r_20"). This will be applied after the above basic transformations.
`generate_url_only`optional	boolean	If true, only return the transformation URL. If false, also make a request to generate the transformed asset.

createUsageReport

Create Usage Report. Generate a comprehensive report of account usage and quotas including storage, bandwidth, transformations, requests, and add-on usage.

Input	Type	Description
`date`optional	date-time (ISO)	Date for the usage report. Must be within the last 3 months. Leave empty for current date.
`include_breakdown`optional	boolean	Whether to include detailed breakdown of transformation types and add-on usage in the response.

deleteResource

Delete Resource. Permanently delete images, videos, or files from Cloudinary.

Input	Type	Description
`deletion_mode`required	one of "public_ids" \| "tag" \| "prefix"	Choose how to specify assets for deletion
`resource_type`required	id (picked from your account)	Select the type of resource to upload to Cloudinary.
`public_ids_dropdown`optional	ids (picked from your account)	Select assets to delete by their public IDs
`public_ids_manual`optional	long text	Or type comma-separated public IDs manually (up to 100). Example: image1,image2,folder/image3
`tag_dropdown`optional	id (picked from your account)	Select existing tags or type new ones (comma-separated)
`tag_manual`optional	text	Or type tag name manually to delete all assets with this tag (up to 1000 assets)
`prefix`optional	text	Delete all assets whose public ID starts with this prefix (up to 1000 assets)
`type`optional	one of "upload" \| "private" \| "authenticated"	The delivery type of assets to delete
`keep_original`optional	boolean	Delete only derived assets, keep the original
`invalidate`optional	boolean	Whether to invalidate CDN cached copies. Takes a few minutes to propagate.

findResourceByPublicId

Find Resource by Public ID. Retrieve details of an asset using its unique public ID.

Input	Type	Description
`resource_type`required	id (picked from your account)	Select the type of resource to upload to Cloudinary.
`public_id_dropdown`optional	id (picked from your account)	Select an asset to find by its public ID
`public_id_manual`optional	text	Or enter the public ID manually if not found in dropdown (e.g., "sample", "folder/image-name")
`delivery_type`optional	one of "upload" \| "private" \| "authenticated"	The delivery type of the asset

uploadResource

Upload Resource. Upload a new image, video, or file to Cloudinary.

Input	Type	Description
`file`required	file	The file to upload to Cloudinary.
`public_id`optional	text	The public ID for the uploaded resource. If not specified, a random ID will be generated.
`folder`optional	id (picked from your account)	Select an existing folder or type a new folder path (e.g., "samples/animals")
`tags`optional	ids (picked from your account)	Select existing tags or type new ones
`overwrite`optional	boolean	Whether to overwrite existing assets with the same public ID.
`use_filename`optional	boolean	Whether to use the original file name as the public ID.

Details

Id: cloudinary
Category: Other
Tags: images, media, cdn, transformation
Package: @activepieces/piece-cloudinary@0.1.3
Tier: Community