For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Sample appsIntegrationsDiscordPlaygroundDevEx repo
GuidesSDK ReferenceAPI Reference
GuidesSDK ReferenceAPI Reference
  • TwelveLabs API
    • Introduction
    • Authentication
  • API Reference
    • Manage indexes
    • Upload content
      • Direct uploads
        • POSTCreate an asset
        • GETRetrieve an asset
        • GETList assets
        • DELDelete an asset
        • PATCHUpdate the user-defined metadata of an asset
        • DELDelete the user-defined metadata of an asset
      • Multipart uploads
      • Video indexing tasks
    • Index content
    • Manage videos
    • Manage entities
    • Any-to-video search
    • Create embeddings v2
    • Create embeddings v1
    • Analyze and segment videos
    • Error codes
LogoLogo
Sample appsIntegrationsDiscordPlaygroundDevEx repo
API ReferenceUpload contentDirect uploads

Update the user-defined metadata of an asset

PATCH
https://api.twelvelabs.io/v1.3/assets/:asset_id/user-metadata
PATCH
/v1.3/assets/:asset_id/user-metadata
$curl -X PATCH https://api.twelvelabs.io/v1.3/assets/6298d673f1090f1100476d4c/user-metadata \
>     -H "x-api-key: <apiKey>" \
>     -H "Content-Type: application/json" \
>     -d '{
>  "user_metadata": {
>    "category": "recentlyAdded",
>    "batchNumber": 5,
>    "rating": 9.3,
>    "needsReview": true
>  }
>}'
1{}
This method updates the user-defined metadata of the specified asset. The platform merges your changes with the existing metadata: - A key with a value creates or replaces that key. - A key set to `null` deletes that key. - A key set to an empty string (`""`) is ignored. - A key you omit from the request keeps its current value. To replace all metadata, first delete it using [`DELETE`](/v1.3/api-reference/upload-content/direct-uploads/delete-asset-user-metadata) method of the `/assets/{asset_id}/user-metadata` endpoint, then use this method to set the new values.
Was this page helpful?
Previous

Delete the user-defined metadata of an asset

Next
Built with

This method updates the user-defined metadata of the specified asset. The platform merges your changes with the existing metadata:

  • A key with a value creates or replaces that key.
  • A key set to null deletes that key.
  • A key set to an empty string ("") is ignored.
  • A key you omit from the request keeps its current value.

To replace all metadata, first delete it using DELETE method of the /assets/{asset_id}/user-metadata endpoint, then use this method to set the new values.

Authentication

x-api-keystring

Your API key.

Note

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

Path parameters

asset_idstringRequired

The unique identifier of the asset whose user-defined metadata to update.

Request

This endpoint expects an object.
user_metadatamap from strings to anyRequired
Metadata that helps you categorize your assets. 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="Note"> If you want to store other types of data such as objects or arrays, you must convert your data into string values. </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
404
Not Found Error

Metadata that helps you categorize your assets. 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}
Note

If you want to store other types of data such as objects or arrays, you must convert your data into string values.