Create an index

POST

This method creates an index.

Request

This endpoint expects an object.
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 and the model options to be enabled for this index. This determines how the platform processes your videos.

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](/docs/extract-video-data#retrieve-thumbnails).

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.

Response

An index has successfully been created

_idstringOptional

Represents the unique identifier of the index object.

Errors

Built with