Sign in

v3

latestOpenAPI 3.1.02026-07-3197486526.1 KB
indexes > indexedAssets

Partial update indexed asset information

This method updates one or more fields of the metadata of an indexed asset. Also, can delete a field by setting it to null.

patch/indexes/{index-id}/indexed-assets/{indexed-asset-id}

Path parameters

index-idstring required

The unique identifier of the index to which the indexed asset has been uploaded.

indexed-asset-idstring required

The unique identifier of the indexed asset 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

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