API ReferenceManage videos

Partial update video information

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

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.

Headers

x-api-keystringRequired

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:

1"user_metadata": {
2  "category": "recentlyAdded",
3  "batchNumber": 5,
4  "rating": 9.3,
5  "needsReview": true
6}
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

Errors