API ReferenceManage indexes

Create an index

This method creates an index.

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>

Request

Request to create an index.
index_namestringRequired
The name of the index. Make sure you use a succinct and descriptive name.
modelslist of objectsRequired
An array that specifies the [video understanding models](/v1.3/docs/concepts/models) and the [model options](/v1.3/docs/concepts/modalities#model-options) to be enabled for this index. Models determine what tasks you can perform with your videos. Model options determine which modalities the platform analyzes.
addonslist of stringsOptional
An array specifying which add-ons should be enabled. Each entry in the array is an addon, and the following values are supported: - `thumbnail`: Enables thumbnail generation. If you don't provide this parameter, no add-ons will be enabled. <Note title="Notes"> - You can only enable addons when using the Marengo video understanding model. - You cannot disable an add-on once the index has been created. </Note>

Response

An index has successfully been created
_idstring

Represents the unique identifier of the index object.

Errors

400
Bad Request Error