---
title: "Create an index"
method: POST
path: "/indexes"
tags: ["indexes"]
---

# Create an index

`POST /indexes`

This method creates an index.

## Headers

- `x-api-key` string, required

## Request body

- object
  - `index_name` string, required — The name of the index. Make sure you use a succinct and descriptive name.
  - `models` IndexesPostRequestBodyContentApplicationJsonSchemaModelsItems[], required — 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.
    - `model_name` string, required — The name of the model. The following models are available: - **Embedding**: These models are proficient at performing tasks such as search and classification, enabling enhanced video understanding. - `marengo3.0`: Enhanced model with sports intelligence and extended content support. - **Generative**: These models generate text based on your videos. - `pegasus1.2`: A model that analyzes multiple modalities to generate contextually relevant text based on the content of your videos. <Note title="Note"> You cannot change the model configuration once the index has been created. </Note>
    - `model_options` string[], required — An array that specifies which modalities the platform analyzes. For the Marengo and Pegasus models, you can specify one or both of the following model options: `visual` and `audio`. For more details, see the [Model options](/v1.3/docs/concepts/modalities#model-options) section.
  - `addons` string[] — 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 `201`

An index has successfully been created

- IndexesCreateResponse201
  - `_id` string — Represents the unique identifier of the `index` object.

## Other responses

- `400` — The request has failed.

---

[API](https://skmtc.net/twelvelabs/apis/twelvelabs-api.md) · [All operations](https://skmtc.net/twelvelabs/apis/twelvelabs-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/twelvelabs/twelvelabs-api/revisions/b6d766c2c340/schema)