assets

Update the user-defined metadata of an asset

Changed on

This method updates the user-defined metadata of the specified asset. The platform merges your changes with the existing metadata:

  • A key with a value creates or replaces that key.
  • A key set to null deletes that key.
  • A key set to an empty string ("") or an empty array ([]) is ignored.
  • A key you omit from the request keeps its current value.

To replace all metadata in a single call, use the PUT method of the /assets/{asset_id}/user-metadata endpoint instead.

patch/assets/{asset_id}/user-metadata

Request

  • Base URL: https://api.twelvelabs.io/v1.3
  • URL: https://api.twelvelabs.io/v1.3/assets/{asset_id}/user-metadata
  • Auth: API key in header x-api-key

Path parameters

asset_idstring required

The unique identifier of the asset whose user-defined metadata to update.

Request body

user_metadataUserMetadata required

Metadata that helps you categorize your assets. The object contains user-defined keys and values, where keys are strings. Each value is a string, a number, a boolean, or an array of strings. Send an integer wider than 53 bits (-9007199254740991 to 9007199254740991), and any identifier you want preserved verbatim, as a string.

Example:

"user_metadata": {
  "category": "recentlyAdded",
  "batchNumber": 5,
  "rating": 9.3,
  "needsReview": true,
  "hashtags": ["summer", "vlog"]
}

Response

Successful response

Changes

  • b8591e05c0baRevision changes
    • warning

      deleted the header request parameter x-api-key

    • info

      the endpoint scheme security x-api-key was added to the API

  • 6205c7327cdeRevision changes
    • info

      api operation id update-user-metadata removed and replaced with assets_update_user_metadata