Sign in

v3

latestOpenAPI 3.1.02026-07-3197486526.1 KB
indexes

Retrieve an index

This method retrieves details about the specified index.

get/indexes/{index-id}

Path parameters

index-idstring required

Unique identifier of the index to retrieve.

Headers

x-api-keystring required

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>

Response

The specified index has successfully been retrieved.

_idstring

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

created_atstring

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

updated_atstring

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

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.

index_namestring

A string representing the name of the index.

total_durationnumber double

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

video_countnumber double

The number of videos uploaded to this index.

addonsstring[]

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