Partial update indexed asset

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

Authentication

x-api-keystring

Your API key.

Note

You can find your API key on the API Keys page.

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>

Path parameters

index-idstringRequired

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

indexed-asset-idstringRequired

The unique identifier of the indexed asset to update.

Request

Request to update the metadata of a video. Delete the fields with a null value.

user_metadatamap from strings to anyOptional

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:

1 "user_metadata": {
2   "category": "recentlyAdded",
3   "batchNumber": 5,
4   "rating": 9.3,
5   "needsReview": true
6 }

Note

To store other types of data, such as objects or arrays, convert your data into string values before sending it.

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**: ```JSON "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

If successful, this method returns a 204 No Content response code. It does not return anything in the response body.

Errors

400

Bad Request Error

1	"user_metadata": {
2	"category": "recentlyAdded",
3	"batchNumber": 5,
4	"rating": 9.3,
5	"needsReview": true
6	}