Retrieve an index | TwelveLabs

This method retrieves details about the specified index.

Authentication

x-api-keystring

Your API key.

Note

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

Your API key. <Note title="Note"> You can find your API key on the <a href="https://playground.twelvelabs.io/dashboard/api-key" target="_blank">API Key</a> page. </Note>

Path parameters

index-idstringRequired

Unique identifier of the index to retrieve.

Response

The specified index has successfully been retrieved.

_idstring or null

A string representing the unique identifier of the index. It is assigned by the platform when an index is created.

created_atstring or null

A string representing the date and time, in the RFC 3339 format (“YYYY-MM-DDTHH:mm:ssZ”), that the index was created.

updated_atstring or null

A string representing the date and time, in the RFC 3339 format (“YYYY-MM-DDTHH:mm:ssZ”), that the index has been updated.

expires_atstring or null

A string representing the date and time, in the RFC 3339 format (“YYYY-MM-DDTHH:mm:ssZ”), when your index will expire.

If you’re on the Free plan, the platform retains your index data for 90 days from creation. After this period, the platform deletes your index data, and this action cannot be undone. To continue using your index beyond this period, consider upgrading to the Developer plan, which offers unlimited index retention. For details, see the Upgrade your plan section.

If you’re on the Developer plan, this field is set to null, indicating no expiration.

A string representing the date and time, in the RFC 3339 format ("YYYY-MM-DDTHH:mm:ssZ"), when your index will expire. If you're on the Free plan, the platform retains your index data for 90 days from creation. After this period, the platform deletes your index data, and this action cannot be undone. To continue using your index beyond this period, consider upgrading to the Developer plan, which offers unlimited index retention. For details, see the [Upgrade your plan](/v1.3/docs/get-started/manage-your-plan#upgrade-your-plan) section. If you're on the Developer plan, this field is set to `null`, indicating no expiration.

index_namestring or null

A string representing the name of the index.

total_durationdouble or null

A number representing the total duration, in seconds, of the videos in the index.

video_countdouble or null

The number of videos uploaded to this index.

modelslist of objects or null

An array containing the list of the video understanding models enabled for this index.

addonslist of strings or null

The list of the add-ons that are enabled for this index.

1	{
2	"_id": "62d9bafa90077fc60af827a0",
3	"created_at": "2024-01-09T11:11:20.463Z",
4	"updated_at": "2024-01-09T11:17:15.296Z",
5	"expires_at": "2024-04-08T11:11:20.463Z",
6	"index_name": "myIndex",
7	"total_duration": 8716.8969,
8	"video_count": 12,
9	"models": [
10	{
11	"model_name": "marengo2.7",
12	"model_options": [
13	"visual",
14	"audio"
15	],
16	"addons": [
17	"thumbnail"
18	]
19	},
20	{
21	"model_name": "pegasus1.2",
22	"model_options": [
23	"visual",
24	"audio"
25	]
26	}
27	]
28	}

1	curl https://api.twelvelabs.io/v1.3/indexes/6298d673f1090f1100476d4c \
2	-H "x-api-key: <apiKey>"

Authentication

Note

Path parameters

Response

Errors

Note