API Reference

Create an index

post
https://api.twelvelabs.io/v1.3/indexes

This method creates an index.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Request to create an index.

string
required

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

models
array of objects
required

An array that specifies the video understanding models and the model options to be enabled for this index. This determines how the platform processes your videos.

models*
addons
array of strings
length between 1 and 1

An array specifying which add-ons should be enabled. Each entry in the array is an addon, and the following values are supported:

If you don't provide this parameter, no add-ons will be enabled.

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.
addons
Headers
string
required

Your API key.

NOTE: You can find your API key on the API Key page.

Responses

Updated about 1 year ago

Did this page help you?
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 year ago

Did this page help you?