Sign in

v3

latestOpenAPI 3.1.02026-07-3197486526.1 KB
indexes

Create an index

This method creates an index.

post/indexes

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>

Request body

index_namestring required

The name of the index. Make sure you use a succinct and descriptive name.

addonsstring[]

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.