For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Sample appsIntegrationsDiscordPlaygroundDevEx repo
GuidesSDK ReferenceAPI Reference
GuidesSDK ReferenceAPI Reference
  • TwelveLabs API
    • Introduction
    • Authentication
  • API Reference
    • Manage indexes
      • The index object
      • POSTCreate an index
      • GETList indexes
      • GETRetrieve an index
      • PUTUpdate an index
      • DELDelete an index
    • Upload content
    • Index content
    • Manage videos
    • Manage entities
    • Any-to-video search
    • Create embeddings v2
    • Create embeddings v1
    • Analyze and segment videos
    • Error codes
LogoLogo
Sample appsIntegrationsDiscordPlaygroundDevEx repo
API ReferenceManage indexes

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 platform when an index is created.
  • index_name: A string representing the name of the index.
  • models: An array that specifies the video understanding models and the model options that are enabled for this index. Models determine what tasks you can perform with your videos. Model options determine which modalities the platform analyzes.
  • 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.
  • 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.
Was this page helpful?
Previous

Create an index

Next
Built with