Cloudinary icon

Cloudinary

Upload images and videos, build optimized transformation and delivery URLs, generate video players, and manage, search, tag, and edit metadata in your Cloudinary media library

Actions23

Asset → Update Asset Structured Metadata

AI-generated

Overview

This node operation updates the structured metadata of an asset in the Cloudinary media library. It allows users to specify the asset by its immutable asset ID and attach or modify structured metadata in JSON format. Additionally, users can choose to invalidate CDN cache copies of the asset to ensure that changes are reflected immediately across content delivery networks. This operation is useful for managing and enriching asset metadata programmatically, such as adding custom fields or updating existing metadata for better asset organization and retrieval.

Use Case Examples

  1. Updating an image asset's metadata with new tags and descriptions.
  2. Adding custom structured metadata fields to a video asset for categorization.
  3. Invalidating CDN cache after metadata update to ensure fresh content delivery.

Properties

Name Meaning
Asset ID The immutable asset_id of the asset to update. This uniquely identifies the asset in Cloudinary and is required.
Structured Metadata The structured metadata to attach to the asset, provided as a JSON object. This metadata can include custom fields and values to enrich the asset's information.
Invalidate CDN A boolean option to specify whether to invalidate CDN cache copies of the asset after updating metadata, ensuring that the latest metadata is served from the CDN.

Output

JSON

  • json
    • assetId - The ID of the asset that was updated.
    • structuredMetadata - The updated structured metadata attached to the asset.
    • invalidate - Indicates whether CDN cache invalidation was performed.

Dependencies

  • Cloudinary API credentials including cloud name, API key, and API secret are required to authenticate and perform the update operation.

Troubleshooting

  • Common issues include providing an invalid or non-existent asset ID, which results in errors indicating the asset cannot be found.
  • Malformed JSON in the structured metadata input can cause parsing errors; ensure the JSON is valid.
  • If CDN invalidation is enabled but fails, the cache may not update immediately, causing stale metadata to be served. Verify CDN settings and permissions.

Links

Discussion