indexes > indexedAssets

Partial update indexed asset information

Changed on

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}

Request

  • Base URL: https://api.twelvelabs.io/v1.3
  • URL: https://api.twelvelabs.io/v1.3/indexes/{index-id}/indexed-assets/{indexed-asset-id}
  • Auth: API key in header x-api-key

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.

Request body

user_metadataUserMetadata

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