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
    • Index content
      • POSTIndex an asset
      • GETRetrieve an indexed asset
      • GETList indexed assets
      • DELDelete an indexed asset
      • PATCHPartial update indexed asset
      • GETList indexed assets for an asset
    • 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 ReferenceIndex content

Partial update indexed asset

PATCH
https://api.twelvelabs.io/v1.3/indexes/:index-id/indexed-assets/:indexed-asset-id
PATCH
/v1.3/indexes/:index-id/indexed-assets/:indexed-asset-id
$curl -X PATCH https://api.twelvelabs.io/v1.3/indexes/6298d673f1090f1100476d4c/indexed-assets/6298d673f1090f1100476d4c \
>     -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 one or more fields of the metadata of an indexed asset. Also, can delete a field by setting it to null.

Was this page helpful?
Previous

List indexed assets for an asset

Next
Built with

Authentication

x-api-keystring

Your API key.

Note

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

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

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.