Create a knowledge store item

curl -X POST https://api.twelvelabs.io/v1.3/knowledge-stores/ks_069e9869-1ea3-7481-8000-dae72bf6be6e/items \
     -H "x-api-key: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "asset_id": "6298d673f1090f1100476d4c"
}'

{
  "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
  },
  "enriched_metadata": {
    "brand": "Acme"
  },
  "created_at": "2024-01-15T09:30:00Z",
  "updated_at": "2024-01-15T09:30:00Z"
}

This method adds an asset to a knowledge store for processing. The operation is asynchronous. The item is created immediately with the queued status and processed in the background.

Asset size limits:

Video: Up to 10 GB
Images: Up to 32 MB

Authentication

x-api-keystring

Your API key.

Note

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

Path parameters

knowledge_store_idstringRequired

The unique identifier of the knowledge store.

Request

This endpoint expects an object.

asset_idstringRequired

The unique identifier of the asset to add to the knowledge store. If you uploaded the asset before your plan moved to the new billing, enable storage accounting for it before you add it to a knowledge store. Use the Enable storage accounting for an asset method.

asset_typeenumOptional

The type of item to create.

Allowed values:

item_metadatamap from strings to strings or integers or doubles or booleans or lists of stringsOptional

Custom metadata for the item, as user-defined key-value pairs. Up to 50 pairs, keys up to 128 characters, string values up to 8192 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. To change it after you create the item, use the PATCH or PUT method of the /knowledge-stores/{knowledge_store_id}/items/{item_id}/item-metadata endpoint.

metadatamap from strings to strings or integers or doubles or booleans or lists of stringsOptionalDeprecated

Deprecated. Use item_metadata instead. The item stores the pairs in its item_metadata field and not in its metadata field. Send item_metadata or metadata, not both. A request that sets both returns a 400 error.

Response headers

LocationstringOptional

The URL of the knowledge store item. Format: /knowledge-stores/{knowledge_store_id}/items/{item_id}.

Response

The item creation request has been accepted and is processing.

asset_typeenum

The type of item.

Allowed values:

_idstringOptional

The unique identifier of the knowledge store item.

asset_idstringOptional

The unique identifier of the source asset.

statusenumOptionalRead-only

The processing status of the item. For the meaning of each value, see the Item statuses section on The knowledge store item object page.

Allowed values:

system_metadataobjectOptionalRead-only

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

metadatamap from strings to strings or integers or doubles or booleans or lists of stringsOptional

The custom metadata of 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 method of the /assets/{asset_id}/user-metadata endpoint. To set custom metadata for the knowledge store item only, use item_metadata.

item_metadatamap from strings to strings or integers or doubles or booleans or lists of stringsOptional

The custom metadata of the knowledge store item. Keys are strings; each value is a string, a number, a boolean, or an array of strings. It is separate from the custom metadata of the source asset. A change to the custom metadata of the source asset does not change this field. The same key can have different values in the metadata field and in the item_metadata field. You set it when you create the item or change it with the PATCH or PUT method of the /knowledge-stores/{knowledge_store_id}/items/{item_id}/item-metadata endpoint. This field is absent when no item metadata has been set.

enriched_metadatamap from strings to anyOptionalRead-only

Metadata that the platform extracts from the whole item, as defined by the enrichment configuration of the knowledge store. It contains the properties that have the granularity keyword set to video for a video, or to image for an image. Properties that have the granularity keyword set to shot do not appear in this field. Keys are the property names; each value matches its property definition. A property with no value is omitted. The field is present only when the item is ready and contains at least one value.

created_atstringOptionalformat: "date-time"

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

updated_atstringOptionalformat: "date-time"

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

Errors

400

Bad Request Error

409

Conflict Error

422

Unprocessable Entity Error