API Reference
SDKsSample appsIntegrationsDiscordPlayground

The index object

The index object is composed of the following fields:

  • _id: A string representing the unique identifier of the index. It is assigned by the API when an index is created.
  • index_name: A string representing the name of the index.
  • index_options: An array of strings that determines how the engine processes your videos. Twelve Labs currently offers three different indexing options: visual, conversation, text_in_video, and logo. For more details, see the indexing options page.
  • created_at: A string representing the date and time, in the RFC 3339 format, that the index was created.
  • updated_at: A string representing the date and time, in the RFC 3339 format, that the index was updated.
  • expires_at: A string representing the date and time, in the RFC 3339 format, when your index will expire.
  • engine_id: A string representing the unique identifier of the engine that the API will use to index the videos in this index. For details about engines, see the Video understanding engines page.
  • video_count: An integer representing the number of videos in the index.
  • total_duration: An integer representing the total duration of the videos in the index.
  • addons: The list of add-ons that are enabled for this index.