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>"

{
  "data": [
    {
      "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": {},
      "created_at": "2024-01-15T09:30:00Z",
      "updated_at": "2024-01-15T09:30:00Z"
    }
  ],
  "page_info": {
    "limit_per_page": 10,
    "page": 1,
    "total_page": 1,
    "total_results": 2
  }
}

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.

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 objectsOptional

An array containing the items in the collection.

page_infoobjectOptional

An object that provides information about pagination.

Errors

400

Bad Request Error