Sign in
knowledgeStoreItemCollections

Create a knowledge store item collection

Creates an item collection in the specified knowledge store. An item collection is a named collection of items. Use item collections to organize and reference subsets of items together.

post/knowledge-stores/{knowledge_store_id}/item-collections

Path parameters

knowledge_store_idstring required

The unique identifier of the knowledge store.

Headers

x-api-keystring required

Your API key.

<Note title="Note"> You can find your API key on the <a href="https://playground.twelvelabs.io/dashboard/api-keys" target="_blank">API Keys</a> page. </Note>

Request body

namestring required

The name of the item collection. Must be unique within the knowledge store.

descriptionstring

An optional description of the item collection.

metadataobject

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. Each value is a string, a number, a boolean, or an array of strings; a nested object, an array holding anything but strings, and a null value are rejected. An integer must fit in 53 bits (-9007199254740991 to 9007199254740991); send a wider value, and any identifier you want preserved verbatim, as a string.

Response

The item collection has been successfully created.

_idstring

The unique identifier of the item collection.

knowledge_store_idstring

The unique identifier of the knowledge store this collection belongs to.

namestring

The name of the item collection.

descriptionstring

The description of the item collection.

metadataobject

Custom metadata for the item collection. Keys are strings; each value is a string, a number, a boolean, or an array of strings.

member_countinteger

The number of items in the collection.

created_atstring date-time

The date and time when the item collection was created, in the RFC 3339 format.

updated_atstring date-time

The date and time when the item collection was last updated, in the RFC 3339 format.

Changes

Changed in 4 of the 11 revisions of this API.232

  • 335e364dd9b511See the full diff
    • ▲

      response property metadata/additionalProperties/ list-of-types was widened by adding types array boolean integer and number to media type application/json of response 201

      response-property-list-of-types-widened

    • ○

      request property / list-of-types was widened by adding types array boolean integer and number to media type application/json

      request-property-list-of-types-widened

  • fd9d80e384a812See the full diff
    • ▲

      the request property's minLength was increased from 0 to 1

      request-property-min-length-increased

    • ●

      the request property's maxLength was set to 2000

      request-property-max-length-set

    • ●

      the request property's maxLength was set to 255

      request-property-max-length-set

  • 5dbd6e8473c91See the full diff
    • ●

      removed the optional property from the response with the status

      response-optional-property-removed

  • c0926990c6621See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 35 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog