> This page is for version v1.3 (default).
> For other versions, use one of these documentation indexes:
> - v1.3 (default): https://docs.twelvelabs.io/v1.3/llms.txt

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.twelvelabs.io/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.twelvelabs.io/_mcp/server.

# Replace the item metadata

PUT https://api.twelvelabs.io/v1.3/knowledge-stores/{knowledge_store_id}/items/{item_id}/item-metadata
Content-Type: application/json

This method replaces the entire `item_metadata` of the specified knowledge store item and returns the item. Unlike the [`PATCH`](/v1.3/api-reference/knowledge-store-items/update-item-metadata) method, which merges your changes with the existing metadata, this method overwrites the stored value in full:

* A key with a value creates or replaces that key.
* A key you omit, or set to an empty string (`""`), an empty array (`[]`), or `null`, is removed.

To clear all item metadata, send an empty object (`{}`) in the `item_metadata` field. The `metadata` field of the item does not change.

Reference: https://docs.twelvelabs.io/api-reference/knowledge-store-items/replace-item-metadata

## Authentication

- `x-api-key` header (required) — Your API key. You can find your API key on the API Keys page.

## Request

### Path parameters

- `knowledge_store_id` (string, required) — The unique identifier of the knowledge store.
- `item_id` (string, required) — The unique identifier of the knowledge store item.

### Body (application/json)

This endpoint expects an object.

- `item_metadata` (map from string to KnowledgeStoreMetadataValue, required) — The complete `item_metadata` of the item after the request. Up to 50 pairs. Keys are strings of up to 128 characters. String values can have up to 8192 characters. Values can be a string, a number, a boolean, or an array of strings. A nested object and an array containing anything other than strings are rejected. An integer must fit in 53 bits (-9007199254740991 to 9007199254740991). Send a wider integer, or an identifier that must be preserved verbatim, as a string.

## Response

### 200

The item metadata has been successfully replaced.

- `asset_type` (enum, required) — The type of item.
  - Allowed values: `video`, `image`
- `_id` (string, optional) — The unique identifier of the knowledge store item.
- `asset_id` (string, optional) — The unique identifier of the source asset.
- `status` (enum, optional) — The processing status of the item. For the meaning of each value, see the [Item statuses](/v1.3/api-reference/knowledge-store-items/the-knowledge-store-item-object#item-statuses) section on **The knowledge store item object** page.
  - Allowed values: `queued`, `pending`, `processing`, `ready`, `failed`
- `system_metadata` (KnowledgeStoreItemSystemMetadata, optional) — System-generated media metadata for the source asset. Its `asset_type` field always matches the item's top-level `asset_type` field.
- `metadata` (map from string to KnowledgeStoreMetadataValue, optional) — Custom metadata from the source asset. Keys are strings; each value is a string, a number, a boolean, or an array of strings. The platform updates it when the user-defined metadata of the asset changes. To change it, use the [`PATCH`](/v1.3/api-reference/upload-content/direct-uploads/update-user-metadata) method of the `/assets/{asset_id}/user-metadata` endpoint. To store metadata on the item alone, use `item_metadata`.
- `item_metadata` (map from string to KnowledgeStoreMetadataValue, optional) — Custom metadata stored on this item alone. Keys are strings; each value is a string, a number, a boolean, or an array of strings. The source asset never changes it, so the same key can have a different value in `metadata` and in `item_metadata`. You set it when you create the item or change it with the [`PATCH`](/v1.3/api-reference/knowledge-store-items/update-item-metadata) or [`PUT`](/v1.3/api-reference/knowledge-store-items/replace-item-metadata) method of the `/knowledge-stores/{knowledge_store_id}/items/{item_id}/item-metadata` endpoint. The field is absent when the item has no item metadata.
- `created_at` (string, optional) — The date and time when the item was created, in the RFC 3339 format.
- `updated_at` (string, optional) — The date and time when the item was last updated, in the RFC 3339 format.

## Errors

### 400 Bad Request Error

The request has failed.

- `code` (string, optional) — A string representing the code associated with the error. See the [Error codes](/v1.3/api-reference/error-codes) page for details.
- `message` (string, optional) — A human-readable string describing the error, intended to be suitable for display in a user interface.

### 404 Not Found Error

The specified resource does not exist.

- `code` (string, optional) — Represents the code associated with the error. See the [Error codes](/v1.3/api-reference/error-codes) page for details.
- `message` (string, optional) — A human-readable string describing the error.

## Types

### KnowledgeStoreMetadataValue

A single custom-metadata value: a string, a number, a boolean, or an array of strings. The value keeps the JSON type sent; a nested object, an array containing anything other than strings, and a null value are rejected. An integer must fit in 53 bits (-9007199254740991 to 9007199254740991). A wider integer, or an identifier that must be preserved verbatim, must be sent as a string.

### KnowledgeStoreItemSystemMetadata

System-generated media metadata for the source asset. Its `asset_type` field always matches the item's top-level `asset_type` field.

- `asset_type`: `video` (video)
  - `codec_name` (string, optional) — The codec used to encode the video.
  - `duration` (double, optional) — The duration of the video in seconds.
  - `filename` (string, optional) — The original filename of the video.
  - `fps` (double, optional) — The frame rate of the video in frames per second.
  - `height` (integer, optional) — The height of the video in pixels.
  - `size` (integer, optional) — The file size of the video in bytes.
  - `width` (integer, optional) — The width of the video in pixels.
- `asset_type`: `image` (image)
  - `codec_name` (string, optional) — The codec used to encode the image.
  - `filename` (string, optional) — The original filename of the image.
  - `height` (integer, optional) — The height of the image in pixels.
  - `size` (integer, optional) — The file size of the image in bytes.
  - `width` (integer, optional) — The width of the image in pixels.

## Examples

**Request**

```json
{
  "item_metadata": {
    "creator_handle": "@jane.doe",
    "view_count": 48210
  }
}
```

**Response**

```json
{
  "asset_type": "video",
  "_id": "ksi_069e9870-3c4d-7abc-9012-3456789abcde",
  "asset_id": "6298d673f1090f1100476d4c",
  "status": "ready",
  "system_metadata": {
    "asset_type": "video",
    "codec_name": "h264",
    "duration": 531.998133,
    "filename": "01.mp4",
    "fps": 29.97,
    "height": 1080,
    "size": 65749715,
    "width": 1920
  },
  "metadata": {},
  "item_metadata": {
    "creator_handle": "@jane.doe",
    "view_count": 48210
  },
  "created_at": "2024-01-15T09:30:00Z",
  "updated_at": "2024-01-15T09:30:00Z"
}
```

**SDK Code**

```python
import requests

url = "https://api.twelvelabs.io/v1.3/knowledge-stores/ks_069e9869-1ea3-7481-8000-dae72bf6be6e/items/ksi_069e9870-3c4d-7abc-9012-3456789abcde/item-metadata"

payload = { "item_metadata": {
        "creator_handle": "@jane.doe",
        "view_count": 48210
    } }
headers = {
    "x-api-key": "<apiKey>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.twelvelabs.io/v1.3/knowledge-stores/ks_069e9869-1ea3-7481-8000-dae72bf6be6e/items/ksi_069e9870-3c4d-7abc-9012-3456789abcde/item-metadata';
const options = {
  method: 'PUT',
  headers: {'x-api-key': '<apiKey>', 'Content-Type': 'application/json'},
  body: '{"item_metadata":{"creator_handle":"@jane.doe","view_count":48210}}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.twelvelabs.io/v1.3/knowledge-stores/ks_069e9869-1ea3-7481-8000-dae72bf6be6e/items/ksi_069e9870-3c4d-7abc-9012-3456789abcde/item-metadata"

	payload := strings.NewReader("{\n  \"item_metadata\": {\n    \"creator_handle\": \"@jane.doe\",\n    \"view_count\": 48210\n  }\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("x-api-key", "<apiKey>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.twelvelabs.io/v1.3/knowledge-stores/ks_069e9869-1ea3-7481-8000-dae72bf6be6e/items/ksi_069e9870-3c4d-7abc-9012-3456789abcde/item-metadata")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<apiKey>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"item_metadata\": {\n    \"creator_handle\": \"@jane.doe\",\n    \"view_count\": 48210\n  }\n}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.put("https://api.twelvelabs.io/v1.3/knowledge-stores/ks_069e9869-1ea3-7481-8000-dae72bf6be6e/items/ksi_069e9870-3c4d-7abc-9012-3456789abcde/item-metadata")
  .header("x-api-key", "<apiKey>")
  .header("Content-Type", "application/json")
  .body("{\n  \"item_metadata\": {\n    \"creator_handle\": \"@jane.doe\",\n    \"view_count\": 48210\n  }\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://api.twelvelabs.io/v1.3/knowledge-stores/ks_069e9869-1ea3-7481-8000-dae72bf6be6e/items/ksi_069e9870-3c4d-7abc-9012-3456789abcde/item-metadata', [
  'body' => '{
  "item_metadata": {
    "creator_handle": "@jane.doe",
    "view_count": 48210
  }
}',
  'headers' => [
    'Content-Type' => 'application/json',
    'x-api-key' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.twelvelabs.io/v1.3/knowledge-stores/ks_069e9869-1ea3-7481-8000-dae72bf6be6e/items/ksi_069e9870-3c4d-7abc-9012-3456789abcde/item-metadata");
var request = new RestRequest(Method.PUT);
request.AddHeader("x-api-key", "<apiKey>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"item_metadata\": {\n    \"creator_handle\": \"@jane.doe\",\n    \"view_count\": 48210\n  }\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "x-api-key": "<apiKey>",
  "Content-Type": "application/json"
]
let parameters = ["item_metadata": [
    "creator_handle": "@jane.doe",
    "view_count": 48210
  ]] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.twelvelabs.io/v1.3/knowledge-stores/ks_069e9869-1ea3-7481-8000-dae72bf6be6e/items/ksi_069e9870-3c4d-7abc-9012-3456789abcde/item-metadata")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "PUT"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```