An index is a basic unit to organize and store your video data (video embeddings and metadata) to facilitate information retrieval and processing.

You can use indexes to group related videos. For example, if you want to upload multiple videos from a car race, Twelve Labs recommends you create a single index and upload all the videos to it. Then, to find a specific moment in that race, you call the /search endpoint once, passing it the unique identifier of the index.

An index is specified by the following fields:

• A name
• A video understanding engine
• One or more indexing options

Note that the engine and the indexing options specified when you create an index apply to all the videos you upload to that index and cannot be changed.

For a description of each field in the request and response, see the API Reference > Create an index page.

Prerequisites

• You’re familiar with the concepts that are described on the Platform overview page.
• You have a valid Twelve Labs account. For details about creating an account and retrieving your API key, see the Authentication page.

Procedure

Follow the steps in the guide below to create an index.