Skip to main content

Metadata

Metadata is additional information that can be provided for a audio, enabling classification, organization, and search based on various properties.

To edit the metadata for a AOD, make a PUT request to the following API with specific AOD id provided:

PUT /bv/cms/v1/aods/:id

Configure the metadata request body with the following options:

FieldTypeDescriptionLimitations
short_descriptionstringA brief summary of the video (not exceeding 100 characters)Max 100 characters (including spaces and symbols)
long_descriptionstringA more detailed description of the videoMax 200 characters (including spaces and symbols)
labelsarraySupplementary metadata objects for categorizationMax 20 labels, 20 characters per label

Here is an example of a request body:

{
"metadata":{
"short_description":"Updated short description",
"long_description":"Updated long description",
"labels":[
{
"name":"Updated label 1"
},
{
"name":"Updated label 2"
}
]
}
}