Sign in

v3

latestOpenAPI 3.1.02026-07-3197486526.1 KB
assets

Replace the user-defined metadata of an asset

This method replaces the entire user-defined metadata of the specified asset. Unlike the PATCH method, which merges your changes with the existing metadata, this method overwrites the stored value in full:

  • A key with a value creates or replaces that key.
  • A key set to an empty string ("") or null is ignored.
  • A key you omit from the request body is removed.

To clear all metadata, send an empty object ({}) in the user_metadata field. This produces the same result as the DELETE method.

put/assets/{asset_id}/user-metadata

Path parameters

asset_idstring required

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

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