API ReferenceManage videos

Partial update video information

Use this method to update one or more fields of the metadata of a video. Also, you can delete a field by setting it to null.

Authentication

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

Path parameters

index-idstringRequired
The unique identifier of the index to which the video has been uploaded.
video-idstringRequired
The unique identifier of the video 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 videos. You can specify a list of keys and values. Keys must be of type `string`, and values can be of the following types: `string`, `integer`, `float` or `boolean`. **Example**: ```JSON "user_metadata": { "category": "recentlyAdded", "batchNumber": 5, "rating": 9.3, "needsReview": true } ``` <Note title="Notes"> - If you want to store other types of data such as objects or arrays, you must convert your data into string values. - You cannot override the following system-generated metadata fields: - `duration` - `filename` - `fps` - `height` - `model_names` - `size` - `video_title` - `width` </Note>

Response

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

Errors