Sign in
assets

Update the user-defined metadata of an asset

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 ("") 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

Path parameters

asset_idstring required

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

Headers

x-api-keystring required

Your API key.

<Note title="Note"> You can find your API key on the <a href="https://playground.twelvelabs.io/dashboard/api-keys" target="_blank">API Keys</a> page. </Note>

Request body

user_metadataUserMetadata required

Metadata that helps you categorize your assets. The object contains user-defined keys and values, where keys are strings and values are one of string, integer, float, or boolean.

Example:

"user_metadata": {
  "category": "recentlyAdded",
  "batchNumber": 5,
  "rating": 9.3,
  "needsReview": true
}
<Note title="Note"> To store other types of data, such as objects or arrays, convert your data into string values before sending it. </Note>

Response

Successful response

Changes

Changed in 2 of the 8 revisions of this API.111

  • 5dbd6e8473c91See the full diff
    • ●

      removed the optional property docs_url from the response with the 400 status

      response-optional-property-removed

  • c0926990c66211See the full diff
    • ▲

      removed the success response with the status 204

      response-success-status-removed

    • ○

      added the success response with the status 200

      response-success-status-added

    This revision also has 35 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog