> 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. # Update an item collection PATCH https://api.twelvelabs.io/v1.3/knowledge-stores/{knowledge_store_id}/item-collections/{collection_id} Content-Type: application/json Updates the `name`, `description`, and `metadata` fields of the specified item collection. Reference: https://docs.twelvelabs.io/api-reference/knowledge-store-items/item-collections/update ## 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. - `collection_id` (string, required) — The unique identifier of the knowledge store item collection. ### Body (application/json) This endpoint expects an object. - `name` (string, optional) — The name of the item collection. Must be unique within the knowledge store. - `description` (string, optional) — An optional description of the item collection. - `metadata` (map from string to KnowledgeStoreMetadataValue, optional) — Custom metadata for the item collection, as user-defined key-value pairs. Up to 10 pairs, keys up to 128 characters, string values up to 2048 characters. Keys are strings; values can be a string, a number, a boolean, or an array of strings. 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). Send a wider integer, or an identifier that must be preserved verbatim, as a string. The provided object replaces the existing metadata in full, so include every key you want to keep and omit the ones you want to remove. To clear all metadata, set this field to an empty object (`{}`). ## Response ### 200 The item collection has been successfully updated. - `_id` (string, optional) — The unique identifier of the item collection. - `knowledge_store_id` (string, optional) — The unique identifier of the knowledge store this collection belongs to. - `name` (string, optional) — The name of the item collection. - `description` (string, optional) — The description of the item collection. - `metadata` (map from string to KnowledgeStoreMetadataValue, optional) — Custom metadata for the item collection. Keys are strings; each value is a string, a number, a boolean, or an array of strings. - `member_count` (integer, optional) — The number of items in the collection. - `created_at` (string, optional) — The date and time when the item collection was created, in the RFC 3339 format. - `updated_at` (string, optional) — The date and time when the item collection 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. ## 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. ## Examples **Request** ```json {} ``` **Response** ```json { "_id": "ksic_069e9870-3c4d-7abc-9012-3456789abcde", "knowledge_store_id": "ks_069e9869-1ea3-7481-8000-dae72bf6be6e", "name": "Q1 highlights", "description": "Highlight clips selected for the Q1 review", "metadata": {}, "member_count": 12, "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/item-collections/ksic_069e9870-3c4d-7abc-9012-3456789abcde" payload = {} headers = { "x-api-key": "", "Content-Type": "application/json" } response = requests.patch(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/item-collections/ksic_069e9870-3c4d-7abc-9012-3456789abcde'; const options = { method: 'PATCH', headers: {'x-api-key': '', 'Content-Type': 'application/json'}, body: '{}' }; 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/item-collections/ksic_069e9870-3c4d-7abc-9012-3456789abcde" payload := strings.NewReader("{}") req, _ := http.NewRequest("PATCH", url, payload) req.Header.Add("x-api-key", "") 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/item-collections/ksic_069e9870-3c4d-7abc-9012-3456789abcde") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Patch.new(url) request["x-api-key"] = '' request["Content-Type"] = 'application/json' request.body = "{}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.patch("https://api.twelvelabs.io/v1.3/knowledge-stores/ks_069e9869-1ea3-7481-8000-dae72bf6be6e/item-collections/ksic_069e9870-3c4d-7abc-9012-3456789abcde") .header("x-api-key", "") .header("Content-Type", "application/json") .body("{}") .asString(); ``` ```php request('PATCH', 'https://api.twelvelabs.io/v1.3/knowledge-stores/ks_069e9869-1ea3-7481-8000-dae72bf6be6e/item-collections/ksic_069e9870-3c4d-7abc-9012-3456789abcde', [ 'body' => '{}', 'headers' => [ 'Content-Type' => 'application/json', 'x-api-key' => '', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.twelvelabs.io/v1.3/knowledge-stores/ks_069e9869-1ea3-7481-8000-dae72bf6be6e/item-collections/ksic_069e9870-3c4d-7abc-9012-3456789abcde"); var request = new RestRequest(Method.PATCH); request.AddHeader("x-api-key", ""); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "x-api-key": "", "Content-Type": "application/json" ] let parameters = [] 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/item-collections/ksic_069e9870-3c4d-7abc-9012-3456789abcde")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "PATCH" 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() ```