An index is a basic unit for organizing and storing video data consisting of video embeddings and metadata. Indexes facilitate information retrieval and processing. The IndexesWrapperclass provides methods to manage your indexes.

Methods

Create an index

Description: This method creates a new index based on the provided parameters.

Function signature and example:

1 create(
2   request: IndexesCreateRequest,
3   requestOptions?: RequestOptions,
4 ): HttpResponsePromise<IndexesCreateResponse>

Parameters

Name	Type	Required	Description
`request`	`IndexesCreateRequest`	Yes	Parameters for creating the index.
`requestOptions`	`RequestOptions`	No	Request-specific configuration.

The IndexesCreateRequest interface has the following properties:

Name	Type	Required	Description
`indexName`	`string`	Yes	The name of the new index. Use a succinct and descriptive name.
`models`	`modelName: 'marengo2.7' \| 'pegasus1.2'; modelOptions: ('visual' \| 'audio')[] }[]`	Yes	A list of objects specifying the video understanding models and the model options you want to enable for this index. Each object is a dictionary with two keys: `modelName` and `modelOptions`.
`addons`	`string[]`	No	A list of add-ons to enable, such as `"thumbnail"`. If omitted, no add-ons are enabled.

Return value: Returns an HttpResponsePromise that resolves to an IndexesCreateResponse instance containing the unique identifier of the newly created index.

API Reference: Create an index.

Related guide: Create an index.

Retrieve an index

Description: This method retrieves details of a specific index.

Function signature and example:

1 retrieve(indexId: string, requestOptions?: Indexes.RequestOptions): core.HttpResponsePromise<TwelvelabsApi.IndexSchema>

Parameters

Name	Type	Required	Description
`indexId`	`string`	Yes	The unique identifier of the index you want to retrieve.
`requestOptions`	`Indexes.RequestOptions`	No	Request-specific configuration.

Return value: Returns a Promise that resolves to an IndexSchema object representing the retrieved index.

The IndexSchema interface contains the following properties:

Name	Type	Description
`id`	`string`	The unique identifier of the index. It is assigned by the platform when an index is created.
`createdAt`	`string`	The date and time, in the RFC 3339 format, that the index was created.
`updatedAt`	`string`	The date and time, in the RFC 3339 format, that the index has been updated.
`expiresAt`	`string`	The date and time, in the RFC 3339 format, when your index will expire. If you’re on the Free plan, the platform retains your index data for 90 days from creation. If you’re on the Developer plan, this field is set to `null`, indicating no expiration.
`indexName`	`string`	The name of the index.
`totalDuration`	`number`	The total duration, in seconds, of the videos in the index.
`videoCount`	`number`	The number of videos uploaded to this index.
`models`	`IndexModelsItem[]`	An array containing the list of the video understanding models enabled for this index.
`addons`	`string[]`	The list of the add-ons that are enabled for this index.

The IndexModelsItem interface contains the following properties:

Name	Type	Description
`modelName`	`string`	The name of the model.
`modelOptions`	`string[]`	An array of strings that contains the model options enabled for this index.

API Reference: Retrieve an index.

List indexes

Description: This method retrieves a paginated list of indexes based on the provided parameters. By default, the platform returns your indexes sorted by creation date, with the newest at the top of the list.

Function signature and example:

1   list(
2     request?: TwelvelabsApi.IndexesListRequest,
3     requestOptions?: Indexes.RequestOptions
4   ): Promise<core.Page<TwelvelabsApi.IndexSchema>>

Parameters:

Name	Type	Required	Description
`request`	`TwelvelabsApi.IndexesListRequest`	No	Parameters for retrieving the list of indexes. Default: `{}`.
`requestOptions`	`Indexes.RequestOptions`	No	Request-specific configuration. Default:`{}`.

The IndexesListRequest interface defines the parameters for listing indexes:

Name	Type	Required	Description
`page`	`number`	No	The page number to retrieve. Default: 1.
`pageLimit`	`number`	No	The number of items to return on each page. Default: 10. Max: 50.
`sortBy`	`string`	No	The field to sort on. The following options are available: “updated_at” - Sorts by the time when the item was updated, “created_at” - Sorts by the time when the item was created. Default: “created_at”.
`sortOption`	`string`	No	The sorting direction. The following options are available: “asc”, “desc”. Default: “desc”.
`indexName`	`string`	No	Filter by the name of an index.
`modelOptions`	`string`	No	Filter by the model options. When filtering by multiple model options, the values must be comma-separated. Example: `"visual,audio"`).
`modelFamily`	`string`	No	Filter by the model family. This parameter can take one of the following values: “marengo” or “pegasus”. You can specify a single value.
`createdAt`	`string`	No	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.
`updatedAt`	`string`	No	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.

Return value: Returns a Promise that resolves to a core.Page<TwelvelabsApi.IndexSchema> instance, representing the indexes that match the specified criteria. See the Retrieve an index section above for complete property details.

The Page class contains the following properties and methods:

Name	Type	Description
`data`	`T[]`	An array containing the current page of items.
`getNextPage()`	`Promise<this>`	Retrieves the next page and returns the updated `Page` object.
`hasNextPage()`	`boolean`	Returns whether there is a next page to load.
`[Symbol.asyncIterator]()`	`AsyncIterator<T>`	Allows iteration through all items across all pages using `for await` loops.

API Reference: List indexes.

Update an index

Description: This method updates the name of an existing index.

Function signature and example:

1 update(indexId: string, request: TwelvelabsApi.IndexesUpdateRequest, requestOptions?: Indexes.RequestOptions): core.HttpResponsePromise<void>

Parameters:

Name	Type	Required	Description
`indexId`	`string`	Yes	The unique identifier of the index to update.
`request`	`TwelvelabsApi.IndexesUpdateRequest`	Yes	The request object containing the update parameters.
`request.indexName`	`string`	Yes	The new name of the index.
`requestOptions`	`Indexes.RequestOptions`	No	Request-specific configuration options.

Return value: Returns a HttpResponsePromise that resolves to void. This method doesn’t return any data upon successful completion.

API Reference: Update an index.

Delete an index

Description: This method deletes an existing index.

Function signature and example:

1 delete(indexId: string, requestOptions?: Indexes.RequestOptions): core.HttpResponsePromise<void>

Parameters:

Name	Type	Required	Description
`indexId`	`string`	Yes	The unique identifier of the index to delete.
`requestOptions`	`Indexes.RequestOptions`	No	Request-specific configuration.

Return value: Returns an HttpResponsePromise that resolves to void. This method doesn’t return any data upon successful completion.

API Reference: Delete an index.

Error codes

This section lists the most common error messages you may encounter while managing indexes.

index_option_cannot_be_changed
- Index option cannot be changed. Please remove index_options parameter and try again. If you want to change index option, please create new index.
index_engine_cannot_be_changed
- Index engine cannot be changed. Please remove engine_id parameter and try again. If you want to change engine, please create new index.
index_name_already_exists
- Index name {index_name} already exists. Please use another unique name and try again.