List items in an item collection

GET

https://api.twelvelabs.io/v1.3/knowledge-stores/:knowledge_store_id/item-collections/:collection_id/items

GET

/v1.3/knowledge-stores/:knowledge_store_id/item-collections/:collection_id/items

$ curl https://api.twelvelabs.io/v1.3/knowledge-stores/ks_069e9869-1ea3-7481-8000-dae72bf6be6e/item-collections/ksic_069e9870-3c4d-7abc-9012-3456789abcde/items \
>      -H "x-api-key: <apiKey>"

1 {
2   "data": [
3     {
4       "asset_type": "video",
5       "_id": "ksi_069e9870-3c4d-7abc-9012-3456789abcde",
6       "asset_id": "6298d673f1090f1100476d4c",
7       "status": "ready",
8       "system_metadata": {
9         "asset_type": "video",
10         "codec_name": "h264",
11         "duration": 531.998133,
12         "filename": "01.mp4",
13         "fps": 29.97,
14         "height": 1080,
15         "size": 65749715,
16         "width": 1920
17       },
18       "metadata": {},
19       "created_at": "2024-01-15T09:30:00Z",
20       "updated_at": "2024-01-15T09:30:00Z"
21     }
22   ],
23   "page_info": {
24     "limit_per_page": 10,
25     "page": 1,
26     "total_page": 1,
27     "total_results": 2
28   }
29 }

Returns a list of the items in the specified item collection.

Authentication

x-api-keystring

Your API key.

Note

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

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>

Path parameters

knowledge_store_idstringRequired

The unique identifier of the knowledge store.

collection_idstringRequired

The unique identifier of the knowledge store item collection.

Query parameters

pageintegerOptionalDefaults to 1

A number that identifies the page to retrieve.

Default: 1.

page_limitintegerOptionalDefaults to 10

The number of items to return on each page.

Default: 10. Max: 50.

Response

The items in the collection have been successfully retrieved.

datalist of objects

An array containing the items in the collection.

page_infoobject

An object that provides information about pagination.

Errors

400

Bad Request Error