For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Sample appsIntegrationsDiscordPlaygroundDevEx repo
GuidesSDK ReferenceAPI Reference
GuidesSDK ReferenceAPI Reference
  • TwelveLabs API
    • Introduction
    • Authentication
  • API Reference
    • Manage indexes
      • The index object
      • POSTCreate an index
      • GETList indexes
      • GETRetrieve an index
      • PUTUpdate an index
      • DELDelete an index
    • Upload content
    • Index content
    • Manage videos
    • Manage entities
    • Any-to-video search
    • Create embeddings v2
    • Create embeddings v1
    • Analyze and segment videos
    • Error codes
LogoLogo
Sample appsIntegrationsDiscordPlaygroundDevEx repo
API ReferenceManage indexes

List indexes

GET
https://api.twelvelabs.io/v1.3/indexes
GET
/v1.3/indexes
$curl -G https://api.twelvelabs.io/v1.3/indexes \
>     -H "x-api-key: <apiKey>" \
>     -d index_name=myIndex \
>     --data-urlencode model_options=visual,audio \
>     -d model_family=marengo \
>     --data-urlencode created_at=2024-08-16T16:53:59Z \
>     --data-urlencode updated_at=2024-08-16T16:55:59Z
1{
2  "data": [
3    {
4      "_id": "62d85fe7340fa665f1fda5dd",
5      "created_at": "2024-01-09T11:11:20.463Z",
6      "updated_at": "2024-01-09T11:17:15.296Z",
7      "expires_at": "2024-04-08T11:11:20.463Z",
8      "index_name": "index-01",
9      "total_duration": 1363.76,
10      "video_count": 2,
11      "models": [
12        {
13          "model_name": "marengo3.0",
14          "model_options": [
15            "visual",
16            "audio"
17          ]
18        },
19        {
20          "model_name": "pegasus1.2",
21          "model_options": [
22            "visual",
23            "audio"
24          ]
25        }
26      ]
27    },
28    {
29      "_id": "62d858ee340fa665f1fda5d8",
30      "created_at": "2024-01-09T11:11:20.463Z",
31      "updated_at": "2024-01-09T11:17:15.296Z",
32      "expires_at": "2024-04-08T11:11:20.463Z",
33      "index_name": "index-02",
34      "total_duration": 579.12,
35      "video_count": 1,
36      "models": [
37        {
38          "model_name": "marengo3.0",
39          "model_options": [
40            "visual"
41          ]
42        },
43        {
44          "model_name": "pegasus1.2",
45          "model_options": [
46            "visual",
47            "audio"
48          ]
49        }
50      ]
51    }
52  ],
53  "page_info": {
54    "limit_per_page": 10,
55    "page": 1,
56    "total_page": 1,
57    "total_results": 2
58  }
59}
This method returns a list of the indexes in your account. The platform returns indexes sorted by creation date, with the oldest indexes at the top of the list.
Was this page helpful?
Previous

Retrieve an index

Next
Built with

Authentication

x-api-keystring
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>

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_bystringOptionalDefaults to created_at
The field to sort on. The following options are available: - `updated_at`: Sorts by the time, in the RFC 3339 format ("YYYY-MM-DDTHH:mm:ssZ"), when the item was updated. - `created_at`: Sorts by the time, in the RFC 3339 format ("YYYY-MM-DDTHH:mm:ssZ"), when the item was created. **Default**: `created_at`.
sort_optionstringOptionalDefaults to desc
The sorting direction. The following options are available: - `asc` - `desc` **Default**: `desc`.
index_namestringOptional
Filter by the name of an index.
model_optionsstringOptional

Filter by the model options. When filtering by multiple model options, the values must be comma-separated.

model_familystringOptional

Filter by the model family. This parameter can take one of the following values: marengo or pegasus. You can specify a single value.

created_atstringOptional

Filter indexes by the creation date and time, in the RFC 3339 format (“YYYY-MM-DDTHH:mm:ssZ”). The platform returns the indexes that were created on the specified date at or after the given time.

updated_atstringOptional

Filter indexes by the last update date and time, in the RFC 3339 format (“YYYY-MM-DDTHH:mm:ssZ”). The platform returns the indexes that were last updated on the specified date at or after the given time.

Response

The indexes have successfully been retrieved.
datalist of objects

An array that contains up to page_limit indexes.

page_infoobject
An object that provides information about pagination.

Errors

400
Bad Request Error

Your API key.

Note

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

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

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

Default: created_at.

The sorting direction. The following options are available:

  • asc
  • desc

Default: desc.