List item collections

curl -G https://api.twelvelabs.io/v1.3/knowledge-stores/ks_069e9869-1ea3-7481-8000-dae72bf6be6e/item-collections \
     -H "x-api-key: <apiKey>" \
     -H "Content-Type: application/json" \
     -d sort_by=created_at

{
  "data": [
    {
      "_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": {
        "category": "financial",
        "review_period": "Q1 2024"
      },
      "member_count": 12,
      "created_at": "2024-01-15T09:30:00Z",
      "updated_at": "2024-02-10T14:45:00Z"
    },
    {
      "_id": "ksic_069e9871-4f5a-8bcd-9012-9876543fedcb",
      "knowledge_store_id": "ks_069e9869-1ea3-7481-8000-dae72bf6be6e",
      "name": "Product Launch Videos",
      "description": "Videos related to the new product launch campaign",
      "metadata": {
        "category": "marketing",
        "campaign": "Spring 2024"
      },
      "member_count": 8,
      "created_at": "2024-03-01T11:00:00Z",
      "updated_at": "2024-03-05T16:20:00Z"
    }
  ],
  "page_info": {
    "limit_per_page": 10,
    "page": 1,
    "total_page": 1,
    "total_results": 2
  }
}

Returns a list of the item collections in the specified knowledge store.

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.

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.

sort_byenumOptionalDefaults to created_at

The field to sort on. The following options are available:

created_at: Sorts by the time, in the RFC 3339 format (“YYYY-MM-DDTHH:mm:ssZ”), when the item collection was created.
updated_at: Sorts by the time, in the RFC 3339 format (“YYYY-MM-DDTHH:mm:ssZ”), when the item collection was last updated.
name: Sorts alphabetically by the name of the item collection.

Default: created_at.

The field to sort on. The following options are available: - `created_at`: Sorts by the time, in the RFC 3339 format ("YYYY-MM-DDTHH:mm:ssZ"), when the item collection was created. - `updated_at`: Sorts by the time, in the RFC 3339 format ("YYYY-MM-DDTHH:mm:ssZ"), when the item collection was last updated. - `name`: Sorts alphabetically by the name of the item collection. **Default**: `created_at`.

Allowed values:

sort_optionstringOptionalDefaults to desc

The sorting direction. The following options are available:

asc
desc

Default: desc.

The sorting direction. The following options are available: - `asc` - `desc` **Default**: `desc`.

Response

The item collections have been successfully retrieved.

datalist of objects

An array containing the item collections.

page_infoobject

An object that provides information about pagination.

Errors

400

Bad Request Error